docsify - 無(wú)需構(gòu)建快速生成文檔網(wǎng)站

longmon 發(fā)布于2019-08-22 10:44 / 1272人閱讀

摘要：你可以指定導(dǎo)航欄文件名的內(nèi)容可以是這樣中文當(dāng)然也支持二級(jí)列表，將生成一個(gè)下拉列表中文為什么是而不用想要實(shí)現(xiàn)的是用最簡(jiǎn)單的方式動(dòng)態(tài)渲染內(nèi)容。

docsify

無(wú)需構(gòu)建快速生成文檔頁(yè)

網(wǎng)站：https://github.com/qingwei-li...
文檔：https://docsify.js.org/zh-cn

特性

無(wú)需構(gòu)建，寫完 markdown 直接發(fā)布

支持自定義主題

容易使用并且輕量

快速上手 創(chuàng)建項(xiàng)目

新建一個(gè)空項(xiàng)目，接著創(chuàng)建一個(gè) docs 目錄并進(jìn)入到 docs 目錄下

mkdir my-project && cd my-project
mkdir docs && cd docs

創(chuàng)建入口文件

創(chuàng)建一個(gè) 404.html 文件，內(nèi)容為

新建 README.md 文件，作為主頁(yè)面

# Title

## balabala

部署！

將項(xiàng)目 push 到 GitHub 倉(cāng)庫(kù)后到設(shè)置頁(yè)面開啟 GitHub Pages 功能，選擇 docs/ 選項(xiàng)

命令行工具

方便快速創(chuàng)建文檔目錄，會(huì)讀取項(xiàng)目的 package.json 里的選項(xiàng)作為 docsify 的配置，支持本地預(yù)覽。

安裝

npm i docsify-cli -g

初始化文檔

默認(rèn)初始化在當(dāng)前目錄，推薦將文檔放在 docs 目錄下

docsify init docs

啟動(dòng)本地服務(wù)

啟動(dòng)一個(gè) server 方便預(yù)覽，打開 http://localhost:3000

docsify serve docs

更多選項(xiàng)參考 docsify-cli

主題

目前提供 vue.css 和 buble.css，直接修改 404.html 里的 cdn 地址即可

壓縮版

更多功能 多頁(yè)面

README.md 作為主頁(yè)面，如果需要其他頁(yè)面，直接在文檔目錄下創(chuàng)建對(duì)應(yīng)的 *.md 文件，例如創(chuàng)建一個(gè) guide.md 那么對(duì)應(yīng)的路由就是 /guide。

導(dǎo)航

導(dǎo)航需要自己寫在 404.html 文件里，效果參考本文檔


  En
  中文

配置參數(shù) repo

參考本文檔的右上角的 GitHub 圖標(biāo)，如果要開啟的話，將 404.html 里的 script 改成

max-level

目錄最大展開層級(jí)，默認(rèn)值為 6

替換節(jié)點(diǎn)元素，默認(rèn)為 #app

sidebar-toggle

Sidebar 開關(guān)按鈕

sidebar

設(shè)置后 TOC 功能將不可用，適合導(dǎo)航較多的文檔，data-sidebar 傳入全局變量名。

load-sidebar

讀取側(cè)邊欄配置文件，如果配置，默認(rèn)加載當(dāng)前目錄下的 _sidebar.md。如果文件不存在，會(huì)顯示 TOC 作為側(cè)邊欄內(nèi)容。如果你有二級(jí)目錄，也應(yīng)該放置一份配置文件。

你可以指定側(cè)邊欄文件名

_sidebar.md 的內(nèi)容可以是這樣的

- [Home](/)
- [Installation](/installation)
- Essentials
  - [Getting Started](/getting-started)
  - [Dynamic Route Matching](/dynamic-matching)
  - [Nested Routes](/nested-routes)
  - [Programmatic Navigation](/navigation)
  - [Named Routes](/named-routes)
  - [Named Views](/named-views)
  - [Redirect and Alias](/redirect-and-alias)
  - [HTML5 History Mode](/history-mode)

load-navbar

讀取導(dǎo)航配置文件，如果配置，默認(rèn)加載當(dāng)前目錄下的 _navbar.md。如果文件不存在，會(huì)顯示 html 里定義的導(dǎo)航欄。

你可以指定導(dǎo)航欄文件名

_navbar.md 的內(nèi)容可以是這樣

- [en](/)
- [中文](/zh-cn)

當(dāng)然也支持二級(jí)列表，將生成一個(gè)下拉列表

- [download](/download)
- language
  - [en](/)
  - [中文](/zh-cn)

FAQ 為什么是 404.html 而不用 index.html

docsify 想要實(shí)現(xiàn)的是用最簡(jiǎn)單的方式 動(dòng)態(tài)渲染內(nèi)容。

例如我有兩個(gè)文檔分別為 README.md 和 guide.md，如果我用 index.html 作為文件名，README.md 可以被正確的渲染因?yàn)槲覀円呀?jīng)規(guī)定它為首頁(yè)文件，但是如果我們?cè)L問 my-domain.com/guide 想要得到的結(jié)果是 guide.md 的內(nèi)容，它將無(wú)法工作，因?yàn)槟夸浵虏⒉淮嬖谝粋€(gè) guide.html 的文件。

但是 GitHub Pages 服務(wù)器找不到資源，就會(huì)回退并渲染 404.html 文件。?

網(wǎng)站：https://github.com/qingwei-li...
文檔：https://docsify.js.org/zh-cn

GPU云服務(wù)器云服務(wù)器文檔生成 python生成文檔 python文檔生成生成API文檔

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/91176.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

longmon

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

stm32mini開發(fā)板lora模塊例程中中文字庫(kù)更新失敗的解決方案

閱讀 3698·2021-11-15 11:37
思維導(dǎo)圖整理大廠面試高頻數(shù)組補(bǔ)充1: 最接近的三數(shù)之和和三數(shù)之和的兩個(gè)不同之處, 力扣16

閱讀 3007·2021-11-12 10:36
手機(jī)主機(jī)名是什么-蘋果手機(jī)主機(jī)名是什么？

閱讀 4516·2021-09-22 15:51
Go 1.17 發(fā)布，主要更新了工具鏈、運(yùn)行時(shí)和庫(kù)的實(shí)現(xiàn)

閱讀 2414·2021-08-27 16:18
h5文字超出，兩行顯示，超出顯示省略號(hào)

閱讀 915·2019-08-30 15:44
css單位

閱讀 2186·2019-08-30 10:58
Image Load Error Handler

閱讀 1806·2019-08-29 17:18
前端開發(fā)面試問題及答案整理

閱讀 3311·2019-08-28 18:25

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

docsify - 無(wú)需構(gòu)建快速生成文檔網(wǎng)站

相關(guān)文章