README.md

manim-kindergarten成员整理的一份manim中文文档教程，目前还在完善当中。如果关于文档内容有问题，可以在这个repo中提出issue。 如果你想要为这个文档做出贡献，可以提交pr。详细内容见贡献规则及编写指南页面。

manimgl直接从manim-kindergarten/manim中拉取并构建文档 cairo-backend分支的文档从本repo的manim分支中拉取构建。

文档地址

https://docs.manim.org.cn

还在完善中

关于文档构建

当前这个repo使用了GitHub Actions和Sphinx自动构建文档。当向master分支push后，会自动触发构建部署在 GitHub Pages上。manim-doc/overview)上提供预览。

附. 文件格式转换：

sphinx要求使用rst格式(reStructuredText语法)，可以使用pandoc把markdown等文件转换rst，或者JupyterNoteBook把py等文件转换rst。

pandoc readme.md --from markdown --to rst -s -o readme.rst

或者

pip install pypandoc

然后

import pypandoc
output = pypandoc.convert_file('somefile.md', 'rst').replace("\r", "")
with open("outputfile.rst", "w", encoding="utf8") as f:
    f.write(output)