ホームCLIiamgio/quarkdown
iamgio

quarkdown

Other#Markdown#Typesetting#Documentation#CLI#Kotlin
GitHub で見る →
54

// 概要

Quarkdown は Markdown に Turing-complete なスクリプト機能を追加した、現代的で汎用性の高い組版システムです。ユーザーは印刷用書籍、学術論文、インタラクティブなプレゼンテーションなど、多様な形式へプロジェクトをコンパイルできます。本プラットフォームはライブプレビューをサポートし、強力な CLI と VS Code 拡張機能を提供することでドキュメント作成プロセスを効率化します。

// 技術解説

Quarkdown は、Markdown を拡張して書籍、学術論文、インタラクティブなプレゼンテーションなどの複雑なドキュメント生成をサポートする、モダンで Turing-complete な組版システムです。Markdown 構文に直接関数型プログラミングの概念を導入することで、動的なコンテンツや高度なレイアウトを扱う際の vanilla 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」フラグを指定してライブプレビューを有効にできます。