MoonBit文档网站
本仓库托管了MoonBit的文档网站 docs.moonbitlang.com。
设置
我们使用 Docusaurus 3 构建此网站。
安装
pnpm install
我们使用pnpm工作空间,网站代码都在moonbit-docs
文件夹中,所以请确保所有以下命令都在moonbit-docs
目录下执行。如果你不知道如何更改目录,请运行:
cd moonbit-docs
本地开发
pnpm start
此命令启动本地开发服务器并打开浏览器窗口。大多数更改无需重启服务器即可实时反映。
预览
pnpm build -l en && pnpm serve
此命令创建生产构建并启动本地服务器以预览生产构建。
编写文档
修改现有文档
Markdown文件位于moonbit-docs/docs
,可以随意修改。
添加新文档
- 在
moonbit-docs/docs
文件夹中添加新的文档文件 - 在
moonbit-docs/sidebars.ts
中更新侧边栏 - 在
moonbit-docs/i18n/zh/docusaurus-plugin-content-docs/current
文件夹中添加相应的中文文档。如果你不懂中文,可以留一个占位符。