跳到主要内容

Docsify-Usage

1. 环境​

运行要求

node版本需要 > 12.x

node -v

npm -v

2. 安装​

# 全局安装 docsify-cli
npm install -g docsify-cli

3. 初始化​

# 创建项目文件夹，初始化为docsify项目
mkdir light-docsify && cd light-docsify
docsify init ./docs

4. 运行​

docsify serve ./docs

5. 推送仓库​

git init
git config user.name "Hui Liu"
git config user.email "whitetulips@163.com"

git add .
git commit -m "Init commit"
git branch -M main
git remote add origin git@github.com:lorchr/light-docsify.git
git push -u origin main

6. 部署站点​

点击进入项目的Settings页面https://github.com/lorchr/light-docsify/settings/pages

Settings -> Pages -> Build and deployment

  • Source : Deploy from a branch
  • Branch : Main docs
  • Save and visit https://lorchr.github.io/light-docsify

7. 问题​

  1. 集成其他的文档

    // 集成官方文档及其导航栏时，不需要此项设置
    alias: {
         // '/.*/_sidebar.md': '/_sidebar.md', //防止意外回退
       },

  2. 部署到Github Pages

    // 本地运行调试
    basePath: "/",

    // 部署到Github Pages
    basePath: "https://lorchr.github.io/light-docsify/",