docsify 笔记

[amenzai]

use method

quick start

# install docsify-cli
npm i docsify-cli -g

# init
docsify init ./docs

# preview site
docsify serve docs

output dir file in ./docs

• index.html as the entry file
• README.md as the home page
• .nojekyll prevents GitHub Pages from ignoring files that begin with an underscore

loading

<!-- index.html -->
<div id="app">Please wait...</div>

more pages

If you need more pages, you can simply create more markdown files in your docsify directory. If you create a file named guide.md, then it is accessible via /#/guide.

example dir

.
└── docs
    ├── README.md
    ├── guide.md
    └── zh-cn
        ├── README.md
        └── guide.md

Matching routes

docs/README.md        => http://domain.com
docs/guide.md         => http://domain.com/guide
docs/zh-cn/README.md  => http://domain.com/zh-cn/
docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide

详情查看