Snekdown

不仅仅是 Markdown

文档 | 版本

描述

本项目的目标是实现一个快速的马达马克解析器，具有扩展语法，以满足我的需求。

核心功能

• 导入
• 参考文献与术语表
• AsciiMath
• 占位符
• 高级图片

先决条件

• Google Chrome/Chromium（用于 PDF 渲染）

安装

二进制文件

您可以在 版本页面 上下载预构建的二进制文件。

Arch Linux

Snekdown 可在 AUR 中找到。

Cargo

您需要一个有效的 Rust 安装，例如使用 rustup。

cargo install snekdown

带有 PDF 渲染

cargo install snekdown --features pdf

用法

使用 snekdown help 和 snekdown <子命令> --help 获取更多信息。

渲染

snekdown render<输入> <输出>

监视

snekdown watch<输入> <输出>

编辑器

我为 Snekdown 创建了一个 VisualStudio Code 扩展。此扩展提供了 snekdown 文件的预览，导出和其他类似命令行界面（CLI）的命令。源代码可以在 此处 找到。

路线图

最终目标是拥有类似于 LaTeX 的功能标记语言。

短期

• 复选框
• 表情符号 (:emoji:)
• 颜色
• 监视和更改时渲染
• 元数据文件
• 参考文献
• 数学
• 术语表
• 基于 Chromium 的 PDF 渲染
• 自定义样式表
• 智能箭头
• 交叉引用
• 图形
• EPUB 渲染
• 文本大小
• 标题页

长期

• 整个解析过程的重写
• 通过模板自定义元素

许可证

本项目采用GPL 3.0许可证。有关更多信息，请参阅LICENSE文件。