开源项目 USDBook 使用指南

开源项目 USDBook 使用指南

USDBookBook of USD source repository.项目地址:https://gitcode.com/gh_mirrors/us/USDBook

1. 项目的目录结构及介绍

USDBook/
├── .github/
│   └── workflows/
├── src/
│   ├── theme/
│   └── ...
├── .gitignore
├── ALAB_LICENSE
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── book.toml
└── preview.png

• .github/workflows/: 包含GitHub Actions的工作流配置文件。
• src/: 项目的源代码目录，包含主题文件和其他资源。
• .gitignore: Git忽略文件配置。
• ALAB_LICENSE: 许可证文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• book.toml: 项目配置文件。
• preview.png: 预览图片。

2. 项目的启动文件介绍

项目的启动文件主要是 book.toml，它包含了项目的配置信息，如主题、输出格式、预处理器等。

3. 项目的配置文件介绍

book.toml 配置文件内容如下：

[book]
authors = ["Remedy Entertainment Plc"]
language = "en"
multilingual = false
src = "src"

[output.html]
default-theme = "Latte"
preferred-dark-theme = "frappe"
curly-quotes = true
git-repository-url = "https://github.com/Remedy-Entertainment/USDBook"
edit-url-template = "https://github.com/Remedy-Entertainment/USDBook/edit/develop/[path]"
git-repository-icon = "fa-github"
additional-css = [
    "theme/custom.css",
    'theme/mdbook-admonish.css',
    'theme/catppuccin.css',
    'theme/catppuccin-highlight.css'
]
no-section-label = true

[output.html.fold]
enable = true
level = 4

[preprocessor.admonish]
command = "mdbook-admonish"
assets_version = "2.0.1"  # do not edit: managed by `mdbook-admonish install`

[preprocessor.catppuccin]
assets_version = "0.1.1"  # DO NOT EDIT: Managed by `mdbook-catppuccin install`

• [book]: 基本配置，包括作者、语言等。
• [output.html]: HTML输出配置，包括主题、引用样式等。
• [output.html.fold]: HTML折叠配置。
• [preprocessor.admonish]: 预处理器配置，用于 admonish 插件。
• [preprocessor.catppuccin]: 预处理器配置，用于 catppuccin 插件。

USDBookBook of USD source repository.项目地址:https://gitcode.com/gh_mirrors/us/USDBook