Docusaurus 的创造,是希望能够让你为开源项目创建一个网站和文档变得非常简单。
在 安装 和 准备 之后,为文档创建基本网站的许多工作已经完成。
你的网站结构看起来像下面这样:
root-of-repo
├── docs
└── website
│ └── blog
│ └── core
│ └── Footer.js
│ └── node_modules
│ └── package.json
│ └── pages
│ └── sidebars.json
│ └── siteConfig.js
│ └── static
这里假设您已经删除了与 初始化 脚本一起安装的
.md示例文件。
所有的文档文件都应该作为 .md 文件放在 docs 文件夹中。 任何博客文章都应该在 blog 文件夹中。
博客帖子的格式必须为 yyyy-mm-dd-your-file-name.md
要创建一个功能齐全的网站,您只需要执行几个步骤:
将您的文档以 .md 文件的形式添加到 /docs 文件夹中,并确保每个文件都有正确的header。 最简单的标题如下,其中 id 是链接名称(例如 docs/intro.html),title 当然是浏览器页面的标题。
---
id: intro
title: 入门
---
这是我的 *新文件内容* ...
将零个或多个文档添加到 sidebars.json 文件,以便您的文档在侧边栏中呈现,如果您想要显示它们。
如果您不将文档添加到
sidebars.json文件中,那么文档依然被渲染,但只能从其他文档链接到该文档,并使用已知的URL进行访问。