Serve a docs site locally with DocsifyJS

run_docsify_locally.md

Serve a docs site locally with DocsifyJS

Choose an option below depending on whether you want to install and run Docsify CLI (optional), or use another server. Either way, you serve the docs directory.

Docsify CLI

1. Install NodeJS.
   • How to install NodeJS and NPM
2. Install Docsify CLI
   • Global, or

     npm install docsify-cli --global

   • Project level.

     npm init
     npm install docsify-cli

     Add to package.json:

     "scripts": {
         "start": "docsify serve docs"
     }

3. Run
   • Global.

     docsify serve docs

   • Project level.

     npm start

Python web server

This approach works without Docsify CLI.

The main draw backs are no hot-reload of the browser on file changes and you need to open the browser console and disable cache, to ensure you get the latest content.

1. Install Python 3.
   • Follow gist.
2. Run

   (cd docs && python3 -m http.server 3000)

Other

Pick another web server quickstart from this gist.

Or use VS Code's Live Server - this may take configuration to ensure you serve from docs and not root, otherwise your links will break.

Then open in the browser:

• localhost:3000/#/

Note: DocsifyJS provides a convenient but optional CLI. It helps you create and serve a DocsifyJS project. In particular, it provides hot-reloading by default when using the server so that an an open localhost webpage will refresh when project files are saved.