亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專欄INFORMATION COLUMN

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

xiaokai / 3726人閱讀

摘要:你可以指定導(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)建,寫(xiě)完 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è)面開(kāi)啟 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ù)覽,打開(kāi) 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)航需要自己寫(xiě)在 404.html 文件里,效果參考本文檔

配置參數(shù) repo

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

max-level

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

el

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

sidebar-toggle

Sidebar 開(kāi)關(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.mdguide.md,如果我用 index.html 作為文件名,README.md 可以被正確的渲染因?yàn)槲覀円呀?jīng)規(guī)定它為首頁(yè)文件,但是如果我們?cè)L問(wèn) 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

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

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

相關(guān)文章

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

    摘要:你可以指定導(dǎo)航欄文件名的內(nèi)容可以是這樣中文當(dāng)然也支持二級(jí)列表,將生成一個(gè)下拉列表中文為什么是而不用想要實(shí)現(xiàn)的是用最簡(jiǎn)單的方式動(dòng)態(tài)渲染內(nèi)容。 showImg(https://segmentfault.com/img/bVGh1i?w=2562&h=1972); docsify 無(wú)需構(gòu)建快速生成文檔頁(yè) 網(wǎng)站:https://github.com/qingwei-li...文檔:https:...

    longmon 評(píng)論0 收藏0
  • docsify - 生成文檔網(wǎng)站簡(jiǎn)單使用教程

    摘要:介紹是一個(gè)動(dòng)態(tài)生成文檔網(wǎng)站的工具。不同于的地方是它不會(huì)生成將轉(zhuǎn)成文件,所有轉(zhuǎn)換工作都是在運(yùn)行時(shí)進(jìn)行。使用來(lái)開(kāi)發(fā)工具,可以方便創(chuàng)建及本地預(yù)覽文檔網(wǎng)站。 1. docsify介紹 docsify 是一個(gè)動(dòng)態(tài)生成文檔網(wǎng)站的工具。不同于 GitBook、Hexo 的地方是它不會(huì)生成將 .md 轉(zhuǎn)成 .html 文件,所有轉(zhuǎn)換工作都是在運(yùn)行時(shí)進(jìn)行。 這將非常實(shí)用,如果只是需要快速的搭建一個(gè)小型的...

    CompileYouth 評(píng)論0 收藏0
  • 技術(shù)甜品店 - 收藏集 - 掘金

    摘要:前端切圖神器前端掘金安裝前端的基礎(chǔ)工作就是把設(shè)計(jì)師的設(shè)計(jì)稿還原成前端頁(yè)面,所以切圖是作為一個(gè)前端的基本技能。 騰訊 Web 工程師的前端書(shū)單 - 閱讀 - 掘金作者:link 2014年一月以來(lái),自己接觸web前端開(kāi)發(fā)已經(jīng)兩年多了,記錄一下自己前端學(xué)習(xí)路上看過(guò)的,以及道聽(tīng)途說(shuō)的一些書(shū),基本上按照由淺入深來(lái)介紹。 JavaScript 入門 《JavaScript權(quán)威指南(第六版)》 ★...

    Gilbertat 評(píng)論0 收藏0
  • Gitalk評(píng)論插件使用教程

    摘要:說(shuō)明是一個(gè)基于和開(kāi)發(fā)的評(píng)論插件。默認(rèn)值類型布爾值,選填,類似評(píng)論框的全屏遮罩效果。默認(rèn)值類型布爾值,選填,如果當(dāng)前頁(yè)面沒(méi)有相應(yīng)的且登錄的用戶屬于,則會(huì)自動(dòng)創(chuàng)建。參考類型布爾值,選填,啟用快捷鍵提交評(píng)論。 1. 說(shuō)明 Gitalk 是一個(gè)基于 GitHub Issue 和 Preact 開(kāi)發(fā)的評(píng)論插件。 Gitalk 的特性: 1、使用 GitHub 登錄2、支持多語(yǔ)言 [en, zh-...

    孫吉亮 評(píng)論0 收藏0

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

0條評(píng)論

閱讀需要支付1元查看
<