UStackUStack
Quarkdown icon

Quarkdown

QuarkdownはMarkdownベースの組版システム。論文・発表・ナレッジベース・静的サイトをdoctype設定で多出力。リアルタイムプレビュー対応。

Quarkdown

Quarkdownとは?

Quarkdownは、LaTeXライクなワークフローでドキュメントを作成するためのモダンでオープンソースのMarkdownベース組版システムです。Markdownでコンテンツを作成し、論文、発表、ナレッジベース、静的ウェブサイト向けのフォーマット出力にコンパイルすることを主目的としています。

サイトでは、Quarkdownを出力タイプに応じて複数のツールを置き換える単一の執筆システムとして位置づけ、LaTeXライクなドキュメントワークフローや一般的なドキュメント/ウィキ形式を含みます。

主な機能

  • Markdown中心の執筆で、読みやすさと高速編集を重視した形式でコンテンツを作成。
  • プレーンMarkdownを超える追加フォーマットと動作のための拡張機能。「より多くの達成のための拡張」と記述。
  • ドキュメント「doctype」(例: pagedplaindocsslides)で選択する複数出力タイプで、異なる成果物に対応。
  • タイピング中のライブ結果を表示するリアクティブプレビュー。「爆速コンパイルとライブプレビュー」対応。
  • 「チューリング完全」と記述されたスクリプティング機能で、ワークフローを再利用し、重複を避ける。

Quarkdownの使い方

Markdownでコンテンツを作成し、Quarkdownの .doctype {…}設定で適切なドキュメントタイプを選択(例: ページ記事/レポート、プレーンノート/ナレッジレイアウト、docsスタイルコンテンツ、またはスライド)。編集中はライブプレビュー/コンパイルフィードバックで出力のレンダリングを確認。

特殊フォーマットや繰り返し構造が必要なら、Quarkdown拡張とスクリプト構文(ドキュメントに関数定義や繰り返しブロックの例)を使用して、再利用ロジックから一貫したセクションを生成。

ユースケース

  • 記事/書籍/レポートスタイルレイアウトで研究論文やレポートを作成(.doctype {paged})。
  • ノートとシンプルな公開向けにプレーンドクタイプを使用(.doctype {plain})で個人ナレッジベースやシンプル静的サイトを維持。
  • 大規模ナレッジベースとドキュメントスタイル読みに適したdocs指向出力(.doctype {docs})でチームウィキや技術ドキュメントセットを構築。
  • インタラクティブ発表向けにコンテンツをフォーマット(.doctype {slides})で講義資料やトークを準備。
  • スクリプティングと拡張で繰り返しやデータライクなビジュアル構造を生成(サイト例: 関数と画像/メタデータ付き繰り返し「カード」やブロック)。

FAQ

  • Quarkdownはどのような出力に対応? サイトではページ記事/書籍/レポート、プレーンノート/シンプル静的サイト、docsスタイルナレッジベース、スライド(講義/トーク用)のdoctypeモードを記述。

  • 執筆中にプレビューは提供? はい。高速コンパイルのライブプレビューを宣伝し、タイピング中に結果を確認可能。

  • QuarkdownはLaTeXスタイルワークフローと互換? ページでは記事/書籍/レポートでLaTeXを置き換えると述べ、別LaTeXツールチェーン不要の対象ワークフローを示唆。

  • 拡張とスクリプティングの役割は? 拡張は基本Markdownを超えるフォーマットと動作を実現。スクリプティングはチューリング完全でワークフローロジックを再利用し、重複を避ける。

  • Quarkdownはオープンソース? はい。メタ記述とページ本文で「open-source」と記述。

代替案

  • 専用組版言語やエコシステムを好む伝統ドキュメント作成向けLaTeX/Typst組版ツールチェーン。
  • Markdown-plus-typesettingと複数doctypeモードではなく構造化ドキュメント公開が主目的なら「docs」カテゴリツールなどのドキュメント/ウィキ静的サイトジェネレータ。
  • 論文やナレッジベースの統一システムより主にスライドデッキが必要ならMarkdownベース発表フレームワーク。
  • Markdown駆動の組版指向ワークフローではなく完全管理編集/公開環境なら汎用ウィキ/ノートプラットフォーム。
Quarkdown | UStack