https://github.com/manim-kindergarten/manim_document_zh

一份manim中文教程文档 / manim tutorial document in Chinese (完善中)
https://github.com/manim-kindergarten/manim_document_zh

documentation manim manim-kindergarten tutorial

Last synced: 3 months ago
JSON representation

一份manim中文教程文档 / manim tutorial document in Chinese (完善中)

• Host: GitHub
• URL: https://github.com/manim-kindergarten/manim_document_zh
• Owner: manim-kindergarten
• License: cc-by-4.0
• Created: 2020-05-12T15:45:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T04:03:07.000Z (almost 2 years ago)
• Last Synced: 2024-05-23T04:43:33.196Z (6 months ago)
• Topics: documentation, manim, manim-kindergarten, tutorial
• Language: Python
• Homepage: https://docs.manim.org.cn
• Size: 54.8 MB
• Stars: 154
• Watchers: 8
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![manim_document_zh](https://fastly.jsdelivr.net/gh/manim-kindergarten/CDN@master/manimgl_assets/DocumentHeader.png)](https://github.com/manim-kindergarten/manim_document_zh)

![docs](https://github.com/manim-kindergarten/manim_document_zh/workflows/docs/badge.svg)

[![GPL License](https://img.shields.io/github/license/manim-kindergarten/manim_document_zh)](https://choosealicense.com/licenses/gpl-3.0/)

![QQ](https://img.shields.io/badge/QQ-862671480-red.svg?style=flat)

[![manim_sandbox](https://img.shields.io/badge/mk-manim__sandbox-brightgreen.svg)](https://github.com/manim-kindergarten/manim_sandbox/)

[![tutorial](https://img.shields.io/badge/tutorial-on_bilibili-ff69b4.svg)](https://space.bilibili.com/171431343/favlist?fid=947158443)

[manim-kindergarten](https://github.com/manim-kindergarten/)成员整理的一份manim中文文档教程，目前还在完善当中。如果关于文档内容有问题，可以在这个repo中提出issue。

如果你想要为这个文档做出贡献，可以提交pr。详细内容见[贡献规则及编写指南](https://docs.manim.org.cn/contribution.html)页面。

manimgl直接从[manim-kindergarten/manim](https://github.com/manim-kindergarten/manim)中拉取并构建文档

cairo-backend分支的文档从本repo的[`manim`](https://github.com/manim-kindergarten/manim_document_zh/tree/manim)分支中拉取构建。

## 文档地址

https://docs.manim.org.cn

还在完善中

## 关于文档构建

当前这个repo使用了[GitHub Actions](https://github.com/features/actions)和`Sphinx`自动构建文档。当向`master`分支`push`后，会自动触发构建部署在

[GitHub Pages](https://docs.manim.org.cn/)上。manim-doc/overview)上提供预览。

**附.** 文件格式转换：

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

```bash

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

```

或者

```bash

pip install pypandoc

```

然后

```python

import pypandoc

output = pypandoc.convert_file('somefile.md', 'rst').replace("\r", "")

with open("outputfile.rst", "w", encoding="utf8") as f:

    f.write(output)

```