Skip to content

Starter template for a docs site using Docsify Themeable πŸ“’ 🎨 πŸ•Έ

License

Notifications You must be signed in to change notification settings

MichaelCurrin/docsify-themeable-quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

21 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Docsify Themeable Quickstart πŸ“’ 🎨 πŸ•Έ

Starter template for a docs site using Docsify Themeable

GitHub tag License

Hosted with GH Pages Made with latest Docsify Made with latest Docsify Themeable

Preview


View site - GH Pages

Use this template

Resources

To learn more about Docsify, see DocsifyJS Tutorial.

See the Docsify Themeable homepage for benefits of using that plugin and its styling and how you can further customize this template project.

Deploy

  1. Get a copy of this repo using the template button above.
  2. Go to Settings of your repo.
  3. Go to the Pages tab.
  4. Enable GitHub Pages on the main branch on the /docs path.
  5. Check the Environments tab on the repo main page.
  6. Wait for your site to build.
  7. Click View deployment to go the URL of your site.

e.g. https://michaelcurrin.github.io/docsify-themeable-quickstart/

Set up locally

This requires Node and make (a Linux and macOS tool) to be installed. Or your preferred way of serving the docs directory as static content.

  1. Get of a copy of this repo or use the original one.
  2. Clone the repo.
  3. Start the docs server.
    $ make docs
  4. Open in the browser:

License

Released under MIT by @MichaelCurrin.