文檔生成工具docsify

1.快速上手

• 全局安裝docsify-cli

npm i docsify-cli -g

• 初始化項(xiàng)目

docsify init ./docs

會(huì)在docs文件夾里生成三個(gè)文件

index.html 作為入口文件
README.md 作為主頁(yè)
.nojekyll 防止 GitHub Pages 忽略以下劃線開頭的文件

修改./docs/README.md文件就可以輕松地更新文檔中的內(nèi)容

• 運(yùn)行

docsify serve docs

可以在瀏覽器中預(yù)覽您的網(wǎng)站http://localhost:3000

2.常見配置項(xiàng)

（1）開啟封面功能

通過在index.html里設(shè)置coverpage為true來激活封面功能，并創(chuàng)建一個(gè)_coverpage.md文件

<!-- index.html --><script>window.$docsify = {coverpage: true} </script> <!-- _coverpage.md --># 文檔生成工具docsify學(xué)習(xí) <small>Bertil Chan</small>> 不甘平凡，不敢平凡- Simple and lightweight - No statically built html files - Multiple themes[GitHub](https://github.com/bertilchan) [Get Started](#文檔生成工具docsify)

（2）修改主題

在index.html中修改引入的css樣式即可，有下面七種可選。

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" /> <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/buble.css" /> <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/dark.css" /> <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/pure.css" /> <!-- Theme: Defaults --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-defaults.css"> <!-- Theme: Simple --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css"> <!-- Theme: Simple Dark --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">

我這里選了buble主題，效果如下

（3）自定義導(dǎo)航欄

通過在index.html里設(shè)置loadNavbar為true并創(chuàng)建_navbar.md

您需要?jiǎng)?chuàng)建一個(gè).nojekyllin./docs以防止 GitHub Pages 忽略以下劃線開頭的文件。

<!-- index.html --><script>window.$docsify = {coverpage: true,loadNavbar: true} </script> <!-- _navbar.md -->* 快速上手* [Quick start](quickstart.md)* [Writing more pages](more-pages.md)* [Custom navbar](custom-navbar.md)* [Cover page](cover.md)* 常用配置* [Configuration](configuration.md)* [Themes](themes.md)* [Using plugins](plugins.md)* [Markdown configuration](markdown.md)* [Language highlight](language-highlight.md)

官方文檔：https://docsify.js.org/#/quickstart

總結(jié)

以上是生活随笔為你收集整理的文档生成工具docsify光速上手的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。