Docsify快速开始

来自泡泡学习笔记
跳到导航 跳到搜索

快速开始

推荐全局安装 docsify-cli 工具，可以方便地创建及在本地预览生成的文档。 

npm i docsify-cli -g


初始化项目

如果想在项目的 ./docs 目录里写文档，直接通过 init 初始化项目。 

docsify init ./docs


开始写文档

初始化成功后，可以看到 ./docs 目录下创建的几个文件

  • index.html 入口文件
  • README.md 会做为主页内容渲染
  • .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件


直接编辑 docs/README.md 就能更新文档内容，当然也可以添加更多页面。


本地预览

通过运行 docsify serve 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 http://localhost:3000 。 

docsify serve docs


手动初始化

如果不喜欢 npm 或者觉得安装工具太麻烦，我们可以直接手动创建一个 index.html 文件。 

 index.html
 
 <!DOCTYPE html>
 <html>
 <head>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <meta charset="UTF-8">
   <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
 </head>
 <body>
   <div id="app"></div>
   <script>
     window.$docsify = {
       //...
     }
   </script>
   <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
 </body>
 </html>

如果你的系统里安装了 Python 的话，也可以很容易地启动一个静态服务器去预览你的网站。 

cd docs && python -m SimpleHTTPServer 3000
cd docs && python -m http.server 3000


Loading 提示

初始化时会显示 Loading... 内容，你可以自定义提示信息。 

  <!-- index.html -->

  <div id="app">加载中</div>

如果更改了 el 的配置，需要将该元素加上 data-app 属性。 

  <!-- index.html -->
  <div data-app id="main">加载中</div>

  <script>
    window.$docsify = {
      el: '#main'
    }
  </script>
取自“http://bubblestudy.info/wiki/index.php?title=Docsify快速开始&oldid=1509”