5thSRD 项目使用教程

1. 项目目录结构及介绍

5thSRD 项目是一个将第五版系统参考文档（SRD）转换为 Markdown 格式的开源项目。项目的目录结构如下：

• docs/: 存放所有 Markdown 格式的文档。
• plugins/: 存放项目可能使用的插件。
• purecss_theme/: 存放项目使用的基础 CSS 主题。
• .gitignore: 指定 Git 忽略的文件和目录。
• README.md: 项目的说明文件。
• build_indexes.py: 用于构建索引的 Python 脚本。
• build_to_test.sh: 用于构建测试环境的 Shell 脚本。
• create_invalidation.sh: 用于创建无效化的 Shell 脚本。
• deploy_to_prod.sh: 用于部署到生产环境的 Shell 脚本。
• license.md: 项目的许可证文件。
• mkdocs.yml: MkDocs 的配置文件。
• offline_build_config.yml: 离线构建的配置文件。
• poetry.lock: Poetry 包管理工具的锁文件。
• pyproject.toml: 项目配置文件，用于定义项目信息和依赖。
• srd_index_builder.py: 用于构建 SRD 索引的 Python 脚本。

2. 项目的启动文件介绍

项目的主要启动文件是 mkdocs.yml。这个文件是 MkDocs 文档生成器的配置文件，它定义了文档的标题、主题、导航结构等。

以下是一个基本的 mkdocs.yml 配置示例：

site_name: 5thSRD
theme: purecssTheme
nav:
- docs/README.md: 主页

在这个配置文件中，您可以定义网站的名称、使用的主题以及导航菜单。

3. 项目的配置文件介绍

项目的配置主要通过 pyproject.toml 和 mkdocs.yml 来完成。

• pyproject.toml 文件定义了项目的依赖和相关信息。例如，它可能包含如下内容：

[build-system]
requires = ["mkdocs", "python-markdown-math"]

[tool.poetry]
name = "5thSRD"
version = "0.1.0"
description = "A Markdown version of the 5th Edition System Reference Document."
authors = ["Your Name <[e-mail]>"]

[tool.poetry.dependencies]
python = "^3.8"

在这个文件中，指定了项目需要的构建系统和依赖，以及项目的基本信息。

• mkdocs.yml 文件，如前所述，是 MkDocs 的配置文件。它允许您自定义文档网站的外观和感觉，包括主题、导航结构等。

确保您在修改这些配置文件后，运行 mkdocs build 命令来构建项目，或者 mkdocs serve 命令来在本地预览项目。