github之强大的文档工具restructuredtext介绍

rst和S5可以高效地完成PPT

使用sphinx记笔记

reStructuredText简明教程

在线编辑

Sphinx使用手册

https://github.com/github/gitignore

安装

pip install docutils
pip install rst2pdf
ReST与org-mode,markdown的比较,可见 知乎,总的来说对于写文档来说ReST还是不错的。

ReST官网

Quick ReST

使用

github之强大的文档工具restructuredtext介绍_第1张图片

插入图片

github之强大的文档工具restructuredtext介绍_第2张图片

插入代码

github之强大的文档工具restructuredtext介绍_第3张图片

相关工具

github之强大的文档工具restructuredtext介绍_第4张图片

ReST实现PPT效果

github之强大的文档工具restructuredtext介绍_第5张图片

ReST实现PDF效果

github之强大的文档工具restructuredtext介绍_第6张图片

github之强大的文档工具restructuredtext介绍_第7张图片

Rst2pdf中文问题

github之强大的文档工具restructuredtext介绍_第8张图片

解决Rst2pdf中文问题

自定义的样式表

{
"styles": {
    "base": {
        "wordWrap": "CJK"
        }
    },
"embeddedFonts" : [["simfang.ttf", "simhei.ttf",
                    "simkai.ttf",  "simsun.ttc"]],
"fontsAlias" : {
    "stdFont": "simsun",
    "stdBold": "simhei",
    "stdItalic": "simkai"
    }
}

github之强大的文档工具restructuredtext介绍_第9张图片

github之强大的文档工具restructuredtext介绍_第10张图片

Sphinx使用

github之强大的文档工具restructuredtext介绍_第11张图片

github之强大的文档工具restructuredtext介绍_第12张图片

github之强大的文档工具restructuredtext介绍_第13张图片

修改conf.py,让它在生成的Tex文件中增加指定的头:

latex_elements = {
...
# Additional stuff for the LaTeX preamble.
'preamble': '''
\usepackage{xeCJK}
\setCJKmainfont[BoldFont=SimHei, ItalicFont=KaiTi_GB2312]{SimSun}
\setCJKmonofont[Scale=0.9]{Droid Sans Mono}
\setCJKfamilyfont{song}[BoldFont=SimSun]{SimSun}
\setCJKfamilyfont{sf}[BoldFont=SimSun]{SimSun}
''',
}
只要是系统中存在的字体都可以使用
查看系统中的中文字体:
fc-list :lang=zh
github之强大的文档工具restructuredtext介绍_第14张图片
github之强大的文档工具restructuredtext介绍_第15张图片
参考 http://wiki.jerrypeng.me/rest-tjlug/



你可能感兴趣的:(github)