mirror of
https://github.com/openmlsys/openmlsys-zh.git
synced 2026-03-24 05:51:02 +08:00
00db02dbfd
* docs: update README and build guide * fix: escape * and _ inside math to prevent markdown emphasis corruption * fix: configure MathJax to use TeX (Computer Modern) font * feat: enhance markdown processing with label and figure collection * fix: remove duplicate bibliography directives from chapter summaries References are already handled at the chapter level, so the :bibliography: directives in summary pages are redundant and cause rendering issues. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1.1 KiB
1.1 KiB
环境安装
机器学习系统书籍部署在GitHub是依赖于mdbook工具实现的。我们推荐使用rust的原生包管理器cargo安装mdbook。
# 安装rust工具链，获取cargo
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
cargo install mdbook
编译HTML版本
在编译前先下载openmlsys-zh ， 所有的编译命令都在这个文件目录内执行。
git clone https://github.com/openmlsys/openmlsys-zh.git
cd openmlsys-zh
使用mdbook工具编译HTML。 请尽量使用build_mdbook.sh脚本进行编译，保证首页正确合并到书籍中去。
sh build_mdbook.sh
# 中文版本
sh build_mdbook_zh.sh
生成的html会在.mdbook/book或者.mdbook-zh/book下。此时我们可以使用tools/assemble_docs_publish_tree.py组装最终的双语发布版本，然后将其拷贝至openmlsys.github.io的docs发布。
具体工作流可以参考.github/workflows/update_docs.yml
样式规范
贡献请遵照本教程的样式规范。
中英文术语对照
翻译请参照中英文术语对照。