首页CLIiamgio/quarkdown
iamgio

quarkdown

Other#Markdown#Typesetting#Documentation#CLI#Kotlin
前往 GitHub →
54

// 项目简介

Quarkdown 是一个现代且通用的排版系统,它通过图灵完备的脚本功能扩展了 Markdown。它使用户能够将项目编译为多种格式,包括可直接打印的书籍、学术论文和交互式演示文稿。该平台支持实时预览,并提供强大的 CLI 和 VS Code 扩展来简化文档创建流程。

// 技术分析

Quarkdown 是一个现代化的、图灵完备的排版系统,它扩展了 Markdown 以支持复杂文档的生成,包括书籍、学术论文和交互式演示文稿。通过将函数式编程概念直接引入 Markdown 语法,它解决了原生 Markdown 在处理动态内容和复杂布局方面的局限性。该项目优先考虑多功能性和开发者体验,提供强大的标准库和实时预览功能,以弥合简单文本格式与专业文档控制之间的差距。

// 核心亮点

01
将函数式编程集成到 Markdown 中,允许用户直接在文档内定义自定义函数、变量和逻辑。
02
支持多种输出格式,包括 HTML、PDF 和纯文本,并针对分页文档、幻灯片和文档 Wiki 提供了专门的模式。
03
提供了一个强大的标准库,包含布局构建器、I/O 操作、数学支持以及循环和条件判断等控制流结构。
04
配备了专门的 VS Code 扩展,支持实时预览,显著改善了文档创建过程中的反馈循环。
05
提供了一个基于 CLI 的项目向导,通过预配置的元数据和内容结构简化了新项目的初始化。
06
保持高性能和快速的编译速度,使其适用于管理大规模知识库和技术文档。

// 典型使用场景

01
创建可直接打印的学术论文和书籍
02
构建交互式演示文稿和幻灯片
03
开发技术文档和知识库

// 快速开始

首先,使用提供的 shell 或 PowerShell 脚本,或者通过 Homebrew/Scoop 安装 Quarkdown。安装完成后,使用 'quarkdown create [directory]' 命令初始化一个新项目,并使用 'quarkdown c [file.qd]' 编译您的文档。如需交互式体验,可以使用 'quarkdown repl' 或通过 '-p -w' 标志启用实时预览。