docsify簡單教程

阿新 • • 發佈：2018-01-09

更新 doctype 但是 readme.md mem earch 沒有建議 update

簡介

一個神奇的文檔網站生成器。
簡單而輕便（?18kB壓縮）
沒有靜態構建的HTML文件
多個主題

快速開始

建議docsify-cli全局安裝，這有助於本地初始化和預覽網站。

npm i docsify-cli -g

初始化

如果在根目錄中編寫文檔

docsify init ./

寫作內容

在之後init完成後，你可以看到在文件列表./根目錄。

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

您可以輕松更新文檔./README.md，當然您可以添加更多頁面。

側邊欄

為了有側邊欄，那麽你可以創建你自己的_sidebar.md

：

首先，你需要設置loadSidebar為true。詳細信息可在配置段落中找到。

<!-- index.html -->

<script>
  window.$docsify = {
    loadSidebar: true
  }
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

創建_sidebar.md：

<!-- docs/_sidebar.md -->

- [Home](/)
- [Guide](guide.md)

其他詳細配置情參考官方文檔

配置index.html

下面是我參考官方文檔修改的一個配置:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Document</title>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  <meta name="description" content="Description">
  <meta name= 
"viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
  <div id="app">Please wait...</div>
  <script>
    window.$docsify = {
      auto2top: true, //當路線改變時，滾動到屏幕的頂部。
      coverpage: true, //激活封面功能。如果為true，則會從中加載_coverpage.md。
      executeScript: true, //執行頁面上的腳本。只解析第一個腳本標記（演示）。如果存在Vue，則默認開啟。
      loadSidebar: true, //_sidebar.md如果為真，則從_sidebar.md文件加載邊欄，否則從指定的路徑加載。
      loadNavbar: true,//_navbar.md如果為真，則從_navbar.md文件加載navbar ，否則從指定的路徑加載。
      mergeNavbar: true,//Navbar將在小屏幕上與側邊欄合並。
      maxLevel: 4,//最大的內容表級別。
      subMaxLevel: 2,//在自定義邊欄中添加目錄（TOC）。
      ga: ‘UA-106147152-1‘,
      name: ‘docsify‘,
      search: {
        noData: {
          ‘/de-de/‘: ‘Keine Ergebnisse!‘,
          ‘/zh-cn/‘: ‘沒有結果!‘,
          ‘/‘: ‘No results!‘
        },
        paths: ‘auto‘,
        placeholder: {
          ‘/de-de/‘: ‘Suche‘,
          ‘/zh-cn/‘: ‘搜索‘,
          ‘/‘: ‘Search‘
        }
      },
      formatUpdated: ‘{MM}/{DD} {HH}:{mm}‘,
      plugins: [
        function(hook, vm) {
          hook.beforeEach(function (html) {
            var url = ‘https://github.com/PYfive/docsify/blob/master/‘ + vm.route.file
            var editHtml = ‘[:memo: Edit Document](‘ + url + ‘)\n‘
            return html
              + ‘\n----\n‘
              + ‘Last modified {docsify-updated} ‘
              + editHtml
          })
        }
      ]
    }
  </script>
  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
  <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
  <script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
  <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
  <script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
  <script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
</body>
</html>

運行

docsify serve --port 4000

訪問 http:/localhost:4000 即可查看頁面效果

總結

docsify用法和gitbook差不多，但是樣式比較好看，個人比較喜歡。

docsify簡單教程

更新 doctype 但是 readme.md mem earch 沒有建議 update 簡介一個神奇的文檔網站生成器。簡單而輕便（?18kB壓縮）沒有靜態構建的HTML文件多個主題快速開始建議docsify-cli全局安裝，這有助於本地初始化和預覽網站

Qt Quick 簡單教程

.com 界面布局引入主動屬性設置語句 anti 枚舉異步上一篇《Qt Quick 之 Hello World 圖文具體解釋》我們已經分別在電腦和 Android 手機上執行了第一個 Qt Quick 演示樣例—— HelloQtQuickApp 。這

fullpage.js簡單教程（一）

style 準備工作 iba 耐心兼容性 css3 動畫 lin per orm 最近準備做一個全屏滾動的網頁，在網上搜了一堆教程，結果大多都是一些很籠統的使用方法，對我這種耐心不超過3秒的笨蛋來說，很晦澀很籠統，所以打算邊研究邊自己寫個教程，有什麽不懂的，我再回來翻看筆

Git和Github簡單教程

發布 code workspace align cal 團隊合作 github init 出現網絡上關於Git和GitHub的教程不少，但是這些教程有的命令太少不夠用，有的命令太多，使得初期學習的時候需要額外花不少時間在一些當前用不到的命令上。這篇文章主要的目標是用較少的

簡單教程

應用用戶信息 html lex 調試 his else str add 1. 獲取微信小程序的 AppID 登錄 https://mp.weixin.qq.com ，就可以在網站的“設置”-“開發者設置”中，查看到微信小程序的 AppID 了，註意不可直接使用服務號或訂閱

webpack簡單教程(2)--使用less並生成獨立的CSS樣式

bsp oct console xtra put 項目信息 pub charset entry 在webpack中配置並使用less直接生成css樣式　　1、在F盤中創建一個文件夾webpack-less 　　2、在文件夾中創建index.html <!DOCTY

Linux搭建ftp服務器簡單教程

自己文章 http 禁止 use -a 登陸 root follow 參考文章：https://www.waitig.com/linux-or-centos-install-vsftpd-and-setup-it.html 步驟概括如下：安裝：yum install

Git簡單教程

cif 切換 cap 版本回退修改 master form email local 該筆記總結廖雪峰Git教程, 參考網站: https://www.liaoxuefeng.com/wiki/0013739516305929606dd18361248578c67b8067

mysql簡單教程-(轉自wid)

query sql函數 success 創建數據庫 date selected 高級功能目錄 ted 21分鐘 MySQL 入門教程目錄一、MySQL的相關概念介紹二、Windows下MySQL的配置配置步驟 MySQL服務的啟動、停止與卸載三、MyS

OSPF多區域配置互通簡單教程

ces 分享 imp idt -o 解決 51cto -i time 一．配置路由器ip二．路由器配置OSPF [R1]ospf [process-id] // 不寫的話，默認是1； [R1-ospf-1] area 0 /

Thymeleaf 模板引用頭部尾部最簡單教程

定義引用 rep pos web b- ace 一個使用 Thymeleaf 模板引用頭部尾部最簡單教程我們可以新建一個簡單的頁尾模板，如：/WEB-INF/templates/footer.html，內容如下： <div th:fragment=

python下載圖片簡單教程

python下載圖片通過urlretrieve方法import os#導入os包，沒有該模塊的可通過pip installl 命令安裝模塊from urllib.request import urlretrieve#導入urllib模塊IMAGE_URL="https://bpic.588ku.co

LNMP環境簡單教程

文件夾 %s 減少深入 tom 相關足夠進程意思一：LNMP可以進行簡單優化，主要2方面。NGINX和PHP進程數，分別是以下2個文件： 1. /usr/local/nginx/conf/nginx.conf2. /usr/local/php/etc/php-fp

2D Tookit簡單教程

創建 bubuko 圖片遊戲 obj 技術優化 gpo 材質 1、在Project Window中點擊Create > tk2d > Sprite Collection”點擊Sprite Collection，創建一個Sprite Collection，S

安利一波PDF轉換成Word的超簡單教程

需要成功轉換器 www 轉換 style 操作 pdf文檔內心將PDF轉換成Word的操作，大家在日常學習工作中都會接觸到；一般這個時候，我們第一反應就是度娘好幾款轉換軟件試一試。用過一輪後，你會發現效果好的轉換器鳳毛麟角，明明就幾頁的文檔，卻出現大量的空格、亂碼、

C++/C語言入門簡單教程（深圳中學科學聯盟信息學會）

else span 形式空間程序入門個數編譯器所有首先我們要明白什麽叫編程。編程就是把想要計算機做的任務用代碼的形式表現出來，然後編譯成計算機能理解的語言（機器語言）。關於編程和計算機基礎的具體內容這裏不復述，可以在深圳中學科學聯盟公眾號發布的文章中查閱。

Burp Suite掃描器漏洞掃描功能介紹及簡單教程

author -s 測試方法 inject psc sql url地址 issue 功能 pageuo 2017-07-25 共852828人圍觀，發現 15 個不明物體工具新手科普 * 本文作者：pageuo，本文屬FreeBuf原創獎勵計劃，未經許可禁止

ASP.NET Core 配置 EF SQLite 支持 - ASP.NET Core 基礎教程 - 簡單教程，簡單編程

microsoft 下載 sqlit 圖片 sqli 可能 ssi htm 技術原文:ASP.NET Core 配置 EF SQLite 支持 - ASP.NET Core 基礎教程 - 簡單教程，簡單編程 ASP.NET Core 配置 EF SQLite 支持

ASP.NET Core 屬性路由 - ASP.NET Core 基礎教程 - 簡單教程，簡單編程

clear 產生 names border 知識是我 netcore sid tps 原文:ASP.NET Core 屬性路由 - ASP.NET Core 基礎教程 - 簡單教程，簡單編程 ASP.NET Core 屬性路由經過前面章節的學習，

ASP.NET Core 使用 EF 框架查詢數據 - ASP.NET Core 基礎教程 - 簡單教程，簡單編程

而且 ews dbcontext ret ogg rabl models 編號 context 原文:ASP.NET Core 使用 EF 框架查詢數據 - ASP.NET Core 基礎教程 - 簡單教程，簡單編程 ASP.NET Core 使用 EF 框架查詢數據

docsify簡單教程

簡介

快速開始

初始化

寫作內容

側邊欄

配置index.html

運行

總結

相關推薦