乱读天书，不求甚解

周祎骏的个人云笔记

乱读天书，不求甚解

docusaurus 1.0 安装

2023-01-25 11:45:58 8 0 0

admin

> 官网： https://docusaurus.io/

## 介绍
这是一款由facebook开源的用于生成静态页面的工具。  
主要服务对象是文档型网站。  
文档由用户用markdown编写。

---
## 安装
#### 安装依赖包
安装 Node.js version >= 10.9.0   
安装 Yarn version >= 1.5  
#### 初始化项目
*使用classic 模板在当前目录下建立my-website目录作为项目根目录*
```bash
npx @docusaurus/init@next init my-website classic
```
#### 在本地启动项目（非静态，调试使用）
```bash
cd my-website
npm run start
```

---
## 目录结构
具体介绍：https://v2.docusaurus.io/docs/installation#project-structure
/blog/ : 博客的文件，不要可以删掉  
/docs/: 文档文件  
/static/: 静态文件，这里的文件在启动后被复制到服务根目录  
/docusaurus.config.js: 配置文件  
/package.json: 需要装哪些包（React app）， 升级的时候需要修改  
/sidebar.js: 边栏配置

---
## 编写/docs/文档
```
---
id: 该文档的id
title: 该文档的标题，默认和id 相同
---
xxxxxxxxxx
xxxxxxxxxx
```

---
## 编写边栏
*编辑sidebars.js*
```js
module.exports = {
  sidebar: {
    '知识管理': [
      {
        'docusaurus': [
            #指向目录 ./docs/docusaurus/ 下的文件，
            #使用的是文件中配置的id
          'docusaurus/快速开始',     
          'docusaurus/本站所做配置',
        ]
      },
    ],
  },
};
```
*效果：*  
![](http://www.leozhouyj.cn:80/api/file/getImage?fileId=63d1162457cb690041000001)

上一篇: docker_ctr_crictl

下一篇: docusaurus 2.0 配置

文档导航