主要观点:DocEaser 是一个用于渲染 Markdown 文档的简单框架,文档可嵌入 Python 编写的 HTMX 组件以增加交互性。
关键信息:
- 可通过
pip install git+https://github.com/linkdd/doceaser
安装。 - 需创建
content/
文件夹用于存放内容,content/_static/
存放静态文件,content/
中 Python 文件为 HTMX 组件,Markdown 文件为文档。 - Markdown 文件可含前端数据头,通过特殊语法嵌入 HTMX 组件,组件可实现不同 HTTP 方法的函数处理请求。
- 服务器基于
waitress
,可通过python -m doceaser.cli --root content/
运行。
重要细节: - 静态文件服务路径为
/_static/...
,HTMX 组件服务路径为/_components/...
,Markdown 文件服务路径为/...
。 - 示例可在
examples/
目录中查看,目前文档主要为 README 和该文件,项目为概念验证,可能不会积极开发但会处理 bug 和讨论需求,有可定制网站布局、缓存 Markdown 渲染等想法,软件遵循 MIT 许可证。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。