Quarkdown 开发者指南

Quarkdown 开发者指南

quarkdown 🪐 Markdown with superpowers. 项目地址: https://gitcode.com/gh_mirrors/qu/quarkdown

1. 项目介绍

Quarkdown 是一个现代化的 Markdown 编辑系统，它基于 CommonMark 和 GFM 扩展而来，提供了一系列的语法扩展和功能，使得用户可以轻松地将项目编译成打印就绪的书籍或交互式演示文稿。Quarkdown 通过内置的脚本支持，允许用户定义自己的函数和变量，创造出动态和复杂的内容，这是传统 Markdown 所无法实现的。

2. 项目快速启动

环境准备

• 安装 Java 17 或更高版本。

安装

从 Releases 页面下载 quarkdown.zip 压缩包，或者使用以下命令自行构建：

gradlew distZip

解压下载的文件，如果需要保持最小化安装，可以使用以下命令仅生成 JAR 文件：

gradlew build

创建项目

使用以下命令创建一个新的 Quarkdown 项目：

quarkdown create [项目目录]

这会启动一个基于提示的项目向导，帮助快速设置新项目，包括所有元数据和初始内容。

或者，你也可以手动创建一个 .qmd 源文件开始。

编译项目

使用以下命令编译 .qmd 文件：

quarkdown c file.qmd

如果项目包含多个源文件，目标文件必须是根文件，即包含其他文件的文件。

选项

• -o <dir> 或 --output <dir>：设置输出文件的目录。
• -p 或 --preview：启用编译后自动重新加载内容。
• -w 或 --watch：当源目录中的文件发生变化时重新编译。
• --pdf：生成 PDF 文件。
• --server-port <port>：本地服务器的端口配置。
• -l <dir> 或 --libs <dir>：设置外部库加载的目录。
• --pretty：生成格式化输出的代码。
• --clean：在生成新文件之前删除输出目录的内容。
• --strict：如果发生错误，程序将退出。
• --no-media-storage：关闭媒体存储系统。

3. 应用案例和最佳实践

（此处可以添加一些具体的应用案例和最佳实践，例如如何使用 Quarkdown 创建交互式演示文稿，如何定制 PDF 输出，以及如何利用 Quarkdown 的脚本功能。）

4. 典型生态项目

（此处可以列举一些使用 Quarkdown 的典型开源项目，以及它们在各自领域的应用和贡献。）

quarkdown 🪐 Markdown with superpowers. 项目地址: https://gitcode.com/gh_mirrors/qu/quarkdown