Use txt2tags in Pelican
1. txt2tags
Markdown 是 Pelican 默认支持的标记语言。其语法简洁,功能实用,多数情况下,可以满足实际的使用需求。
txt2tags 是一个类似的项目:
Txt2tags is a text formatting and conversion tool.
相比于 Markdown:
- txt2tags 包括了以下这些有用的功能:
- 可以指定生成目录,比如
%!options: -n --toc
- Numbered Title
- Table
- Macros
- 可以指定生成目录,比如
- 当然也有一些不足:
- Verbatim line 没有语法高亮
更多功能,请参考用户手册。
总的来说,txt2tags 的这些功能,可以使得内容更加清晰,有条理。
2. txt2tags reader plugin
浏览了 pelican-plugins 官方插件库,发现它并没有 txt2tags 的插件。
还好是开源软件,缺什么,动手写一个就是了。参考了 multimarkdown_reader 的代码,写了个 txt2tags_reader。
然后发了个 pull request,没想到很快就被合并进去,成为了 pelican-plugins 官方插件库的一部分。
2.1. How to use
- 更新 pelican-plugins
- Config file
PLUGINS = ["txt2tags_reader"]
- Content file
使用 txt2tags 语法来编辑内容,并将内容文件的扩展名设置为
t2t
,或者txt2tags
即可。
2.2. Known Issues
- 目录里是相对路径的定位方式,如果一篇内容被部分地包含在另一个页面里,此时点击目录里的链接,就有问题了。