📝 文档编写#

Bookshelf 致力于简化地图制作并提高其可访问性。我们努力创建了全面的文档网站，要求所有新功能都需妥善记录。

✍️ 撰写文档#

文档使用 Markdown 格式编写，并通过 Myst Parser 扩展。你可查阅Myst Parser 文档。添加或更新文档时，遵循现有页面和功能的结构即可。所有图像存储在 /docs/_imgs 文件夹中。

🔨 构建文档#

为验证文档更改是否符合预期，可在本地计算机构建并查看：

  1. 打开终端（Windows 系统请使用 PowerShell）

  2. 选择以下任一选项构建并查看文档：

选项 1：构建文档#

uv run docs build

此命令将生成文档，结果位于 /docs/_build 文件夹中。

选项 2：支持热重载的构建#

uv run docs watch

此选项同样生成文档，但支持通过浏览器访问 http://127.0.0.1:8000 并启用热重载功能，任何修改将自动在浏览器中更新。