docsify

Initialize new documentation site

$ docsify init [./docs]

$ docsify serve [./docs]

$ docsify serve [./docs] --port [4000]

$ docsify generate [./docs]

$ docsify serve [./docs] --livereload-port [35729]

docsify command [options] [path]

docsify is a documentation site generator that dynamically renders Markdown files without building static HTML. It loads and parses Markdown files on the fly, providing instant updates during editing.
The tool creates simple, elegant documentation websites from Markdown files. Features include full-text search, multiple themes, plugin support, and GitHub Pages compatibility. Configuration is minimal, typically just an index.html and Markdown files.
docsify is particularly suited for project documentation, requiring no build step and supporting features like cover pages, sidebars, and embedded code samples.

COMMAND

Operation: init, serve, generate.

Documentation directory.

Initialize new docsify project.

Start local server.

Server port (default: 3000).

Live reload port.

Open browser automatically.

Display help information.

Requires JavaScript for rendering (no static HTML). SEO may be affected by client-side rendering. Large documentation sites may have initial load delay.

docsify was created by cinwell and released as an open-source project. It gained popularity as a lightweight alternative to documentation generators like GitBook and VuePress, emphasizing simplicity and no build requirements.

mkdocs(1), vuepress(1), gitbook(1)