README_zh.md

English | 中文

Obelisk 是一个 Markdown 文档库发布工具，它能够简单、快速的帮你生成 HTML 文档。特别的，出于个人的偏爱，Obelisk 针对 Obsidian 文档库做了大量的优化，可作为官方发布服务的一个替代方案。

主要特性

• 兼容 Markdown 标准规范及常用扩展规范
• 支持自定义主题
• 支持文档搜索
• 支持反向链接
• 支持 Obsidian 社区的一些主流插件
  • Excalidraw
  • Banner
  • Kanban
  • Icon Folder
  • ……

快速上手

请参考这里的 使用文档。如你所料，文档站点也正是用 Obelisk 生成的。

屏幕截图

文档

图谱

扩展

路线图

• CommonMark
• GFM Extensions
• Callout
• LaTeX
• Comment
• Embed
  • Image
  • Audio
  • Video
  • Excalidraw
  • PDF
  • Markdown
• Plugin
  • Banner
  • Excalidraw
  • Admonition
  • Icon Folder
  • Kanban
  • Charts
  • Timeline
• Theme
• Search
• Graph
• Back links
• Tag links