内容
介绍
嘿！我在网上被称为airscript。
今天，我想与您分享如何使用Docusaurus来记录您的下一个很棒的项目。
Docusaurus是一个多合一的工具，这意味着您可以使用它创建前页面，博客等。
我将仅通过此博客文章介绍文档部分。
要求
甚至在开始下一节之前，请确保在计算机上安装了唯一的要求：Node.js。
建议的版本从16.14及更高版本进行，您可以检查刚刚在选择终端内键入node -v的版本。
安装
获得所有要求后，您可以通过简单地运行这些简单命令来轻松地安装docusaurus：
npx create-docusaurus@latest documentation classic
# If you prefer TypeScript, you can pass an argument for that.
npx create-docusaurus@latest documentation classic --typescript
使用上面的命令，我们可以在使用打字稿的情况下创建一个完全经典的Docusaurus项目。
还有更多的模板，例如facebook，而不是经典，但我们没有在本文中介绍它们。
运行该命令后，您应该在documentation文件夹中具有这样的情况：
documentation
├── blog
│ ├── file.md
│ ├── ...
│ └── ...
├── docs
│ ├── file.md
│ ├── ...
│ ├── ...
│ └── ...
├── src
│ ├── css
│ │ └── custom.css
│ └── pages
│ ├── styles.module.css
│ └── index.js
├── static
│ └── img
├── docusaurus.config.js
├── package.json
├── README.md
├── sidebars.js
└── yarn.lock
跑步
现在您有了一个完全脚手架的项目，让我们尝试一个简单的第一次运行。
可以按照此命令轻松完成：
cd documentation
npm run start
配置
关于配置部分，您可能已经看到我们的文档现在有一些示例。
为了反映我们的项目，我们必须改变这一点。
在所有这些之前，我们必须配置如何呈现文档。
在项目中您会找到一个docusaurus.config.js文件。
该文件包含您的文档网站所需的所有配置。
在这里，您可以选择您的网站是否只需要文档甚至博客！
或简单地更改其标题或徽标。
有关您可以在这里做什么的更多信息，请看一下这个documentation page。
页面
最后，让我们看看如何添加文档页面甚至编辑现有的页面。
开始在Inner docs文件夹中创建一个Markdown文件：
touch docs/hello.md
文件夹结构将是这样的：
documentation
├── docs
│ └── hello.md
├── src
│ └── pages
├── docusaurus.config.js
├── ...
然后，您可以开始编辑该标记文件，添加一些丰富的内容：
---
description: "Hello Page."
---
# Hello
Hey there! I'm a documentation page.
简单，不是吗？
在此文件中，您可以简单地使用Markdown，并且所有内容都将在您的文档网站中使用丰富的内容渲染。
我还提供了一个描述以将元数据添加到此页面。
为此，我使用了Front Matter。
结论
我们正处于旅途的尽头。
我们已经看到了如何安装Docusaurus，如何配置它，甚至如何创建我们的第一个文档页面。
如果您有兴趣，我们可以在以后的文章中讨论将此实际文档部署到您首选的网站。
在此之前，请感谢您。
共享支持
如果您喜欢这篇文章，请来告诉我！
你太害羞了吗？没问题。只需访问airscript.it，并在您喜欢的社交平台上分享您的支持。
如果您想让我更快乐，只需跟随，分享或在GitHub上出演我和我的项目。