RepChain Cross

运用mkdocs工具的material主题，生成基于RepChain2.0的跨链组件

项目环境

• 安装mkdocs前需要安装python3环境，此处使用Python3.9。
• 在控制台运行如下命令即可安装mkdocs：

pip install mkdocs

• 使用pip安装Material for MkDocs，这将自动安装所有依赖的兼容版本：MkDocs、Markdown、Pygments和Python Markdown Extensions：

pip install mkdocs-material

使用说明

• 在项目目录下，有一个子目录docs，其中包含了源文件、页面等数据； 还有一个文件mkdocs.yml，其中是配置文件。
• 在配置文件mkdocs.yml中修改为material主题：

theme:
  name: material

• 添加页面：在docs目录下添加新页面的Markdown文件，并在配置文件mkdocs.yml中添加nav配置项的信息。具体使用方法详见MkDocs官方文档和Material for MkDocs官方文档。
• 运行如下命令实现修改保存后实时预览：

mkdocs serve

• 完成编辑后，使用如下命令为Markdown文件构建静态站点：

mkdocs build

• 通过配置mike插件扩展，可以使用Git管理MkDocs生成文档的多个版本。在mkdocs.yml配置文件中进行如下设置：

extra:
  version: 
    provider: mike

使用pip安装mike插件：

pip install mike

要部署当前版本的文档，只需运行：

mike deploy [version]

关于mike插件的使用方法，请访问官方文档。

• 通过配置mkdocs-with-pdf插件扩展，可以将MkDocs生成文档导出为PDF文件。在mkdocs.yml配置文件中进行如下设置：

plugins:
    - with-pdf

使用pip安装mkdocs-with-pdf插件：

pip install mkdocs-with-pdf

关于mkdocs-with-pdf插件的使用方法，请访问官方文档。