基于标记的模块化文档生成器,可生成pdf、docx、html等。
foliant的Python项目详细描述
叶面
foliant是一个一体化的文档创作工具。它允许您从单个标记源生成pdf和docx格式的独立文档以及网站。
foliant是一个higher order工具,这意味着它使用其他程序来完成它的工作。对于pdf和docx,它使用Pandoc,对于网站,它使用MkDocs。
叶型预处理器允许您在其他文档中包含部分文档,使用标志显示和隐藏内容,从文本呈现图表,等等。
安装
foliant是用python编写的,需要python 3.6。
要安装叶面剂,请使用pip:
$ pip install foliant
后端、扩展和预处理器也与pip一起安装。对于快速启动,您需要MkDocs backend和init CLI extension:
$ pip install foliantcontrib.mkdocs foliantcontrib.init
要构建pdf和docx,请安装Pandoc backend:
$ pip install foliantcontrib.pandoc
快速启动
- 创建新项目:
$ foliant init
Enter the project name: Hello Foliant
✓ Generating Foliant project
─────────────────────
Project "Hello Foliant" created in /path/to/hello-foliant
此命令创建一个基本的叶面项目:
hello-foliant/
├── foliant.yml
└── src
└── index.md
1 directory, 2 files
foliant.yml
是项目配置文件,src
是包含项目源文件的目录(最初,只有一个文件index.md
)。
- 从新创建的项目创建网站:
$ foliant make site -p hello-foliant/ ✓ Parsing config ✓ Applying preprocessor mkdocs ✓ Making site with MkDocs ───────────────────── Result: Hello_Foliant-0.1.0-2017-11-24.mkdocs
- 在站点目录中运行本地Web服务器,并在浏览器中查看站点:
$ cd Hello_Foliant-0.1.0-2017-11-24.mkdocs $ python -m http.server Serving HTTP on 0.0.0.0 port 8000(http://0.0.0.0:8000/) ...
- 从项目中生成独立的PDF文档:
$ foliant make pdf -p hello-foliant/ ✓ Parsing config ✓ Applying preprocessor mkdocs ✓ Making pdf with Pandoc ───────────────────── Result: Hello_Foliant-0.1.0-2017-11-24.pdf
Important
To produce pdf, Pandoc first converts Markdown to tex and then coverts it to pdf. To convert pdf > from tex, you need to have a LaTeX distribution installed: