docsify

Initialize a new documentation in the current directory

$ docsify init

$ docsify init [path/to/directory]

$ docsify serve [path/to/directory]

$ docsify serve [[-p|--port]] [80] [path/to/directory]

$ docsify generate [path/to/directory]

docsify <command> [options]
Commands: init [dir], serve [dir], build [dir]

init [dir]
    Initialize docsify project in dir (default: current)

serve [dir]
    Start dev server for dir with live reload

build [dir]
    Build static site from dir to _build

--port, -p PORT
    Server port (default: 3000)

--open
    Auto-open browser

--version
    Show version

--help
    Show help

Docsify is a magical documentation site generator that generates a documentation website from Markdown files without a build process. It features a progressive web app architecture, load-on-demand functionality, and customizable themes. The docsify CLI tool, installed via npm, simplifies project setup, local serving, and building.

Key features include instant preview during editing, support for plugins like search and copy-code, and deployment readiness for GitHub Pages or any static host. Ideal for open-source projects and personal docs, it prioritizes simplicity over complex static site generators.

Usage starts with docsify init to scaffold a project, docsify serve for live reloading, and docsify build for production output. Requires Node.js (≥10) and global npm installation: npm i docsify-cli -g.

Requires Node.js and npm i docsify-cli -g. Not native Linux binary. Build output goes to _build dir.

npm i docsify-cli -g or npx docsify init ./docs

Edit index.html for theme, plugins, loadSidebar.

Created by Qing Wei in 2016. Gained popularity for zero-config Markdown docs. CLI evolved with v4+ for build/serve. Actively maintained on GitHub.

npm(1), node(1), pandoc(1)