Repolode
iamgio

iamgio/quarkdown

関数呼び出しを備えたMarkdownベースの組版システム。1つのソースから書籍、論文、スライド、Webサイト、Wikiを生成できます。

代替できる製品:LaTeXNotion

スター
16,350
フォーク
522
未解決の Issue
21
最終コミット
3 日前

これは何?

Quarkdownは、関数呼び出し、変数、レイアウト・数式・I/O・条件分岐の標準ライブラリを追加した、CommonMarkおよびGFM拡張のMarkdownベースの組版システムです。1つのプロジェクトから、印刷用に仕上げたページ形式のドキュメント、学術論文、連続したナレッジベース、インタラクティブなreveal.jsプレゼンテーション、ドキュメントサイトを生成できます。

出力形式はHTML(通常、ページ形式、スライド、docsの各モード)、PDF、GFM Markdown、プレーンテキストに対応しています。ドキュメントの種類は、ソース内の.doctype関数で指定します。ライブプレビューとwatchモードを組み合わせると、ファイルの変更に応じてソースを再コンパイルできます。また、プロジェクトウィザードで新しいドキュメントをセットアップできます。

Quarkdownは、システムリソースへのアクセスを制限する厳格な権限システムを採用しています。VS Code向けのエディターサポートがあり、IntelliJ IDEAとVim向けには非公式プラグインが提供されています。

主な機能

  • 01Markdown構文に関数呼び出し、変数、スクリプト機能を追加します。
  • 021つのソースからHTML、PDF、GFM Markdown、プレーンテキストを生成します。
  • 03HTMLドキュメントとして、通常、ページ形式、スライド、docsの4種類を提供します。
  • 04ライブプレビューと、watchモードによる再コンパイルに対応しています。
  • 05レイアウトビルダー、数式、I/O、条件分岐の標準ライブラリを備えています。
  • 06デフォルトでシステムリソースへのアクセスを制限します。

ユースケース

  • Markdownから印刷用PDFを生成する必要がある学術論文や書籍の執筆。
  • テキストソースから生成する、インタラクティブなスライド資料の作成。
  • 技術ドキュメントサイトや個人用ナレッジベースの運用。
  • 関数呼び出しを1行記述して、ドキュメント間で繰り返し使うコンテンツを再利用。

クイックスタート

  1. 1

    Homebrewでインストール(Linux/macOS)

    brew install quarkdown-labs/quarkdown/quarkdown
  2. 2

    セットアップウィザードで新しいプロジェクトを作成

    quarkdown create [directory]
  3. 3

    ルートのソースファイルをコンパイル

    quarkdown c file.qd

使う前に知っておきたいこと

  • GPL-3.0ライセンスの下で提供されています。コピーレフトライセンスのため、派生物も同じ条件で配布する必要があります。
  • 手動インストールの場合、PDFを書き出すにはChromium系ブラウザーを別途用意する必要があります。

収録されている特集

トピック

よくある質問

quarkdown とは?
関数呼び出しを備えたMarkdownベースの組版システム。1つのソースから書籍、論文、スライド、Webサイト、Wikiを生成できます。 Quarkdownは、関数呼び出し、変数、レイアウト・数式・I/O・条件分岐の標準ライブラリを追加した、CommonMarkおよびGFM拡張のMarkdownベースの組版システムです。1つのプロジェクトから、印刷用に仕上げたページ形式のドキュメント、学術論文、連続したナレッジベース、インタラクティブなreveal.jsプレゼンテーション、ドキュメントサイトを生成できます。
quarkdown は無料で使えますか?ライセンスは?
quarkdown は GPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
quarkdown は今もメンテナンスされていますか?
活発にメンテナンス中。quarkdown の最終コミットは 2026年11月5日 です。
quarkdown は何に使えますか?
Markdownから印刷用PDFを生成する必要がある学術論文や書籍の執筆。 テキストソースから生成する、インタラクティブなスライド資料の作成。 技術ドキュメントサイトや個人用ナレッジベースの運用。 関数呼び出しを1行記述して、ドキュメント間で繰り返し使うコンテンツを再利用。
quarkdown のインストール方法は?
Homebrewでインストール(Linux/macOS): brew install quarkdown-labs/quarkdown/quarkdown セットアップウィザードで新しいプロジェクトを作成: quarkdown create [directory] ルートのソースファイルをコンパイル: quarkdown c file.qd
quarkdown はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/iamgio/quarkdown

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト