Quarkdown icon

Quarkdown

Quarkdownは、論文、プレゼンテーション、ナレッジベース、静的サイトを作成できるオープンソースのMarkdownベース組版システム。CLIでライブプレビュー、HTML出力、PDF書き出しに対応。

Quarkdown

概要

Quarkdownは、論文、プレゼンテーション、ナレッジベース、静的ウェブサイトを作成するためのMarkdownベースの組版システムです。Markdownでの執筆に加え、文書構造、レイアウト、公開機能を組み合わせるオープンソースツールとして紹介されています。

この製品はコマンドラインでの作業を前提に設計されています。プロジェクトを作成し、`.qd` ファイルを編集してコンパイルし、必要に応じてライブプレビューを行ったりPDFへ書き出したりできます。提供された資料では、Quarkdownは連続的なノート、ページ分割された文書、スライド、ドキュメント形式のサイトなど、複数の文書形式に対応する単一ツールとして示されています。

機能

Markdownに独自の文書ロジックを追加

Markdownで書き、その後Quarkdown固有の構文を使って関数、変数、コンテナ、ボックス、再利用可能な要素を扱えます。クイックスタートでは、名前付き引数と位置引数を使った関数呼び出しや、`.function` で作成するカスタムコンポーネントが紹介されています。

HTMLとPDFの出力

コマンドラインからHTMLにコンパイルし、PDFとして書き出せます。クイックスタートでは、HTML出力に `quarkdown c main.qd`、PDF書き出しに `quarkdown c main.qd --pdf` を使う例が示されています。

反応的なライブプレビュー

書きながら変更内容をライブでプレビューできます。クイックスタートでは、`-p -w` によりブラウザが自動で開き、編集しながら結果を確認できると説明されています。

複数の文書レイアウト

複数の文書タイプから選んで、異なる公開先に合わせられます。wikiでは `plain`、`paged`、`slides`、`docs` が挙げられており、ノート、ページ型文書、プレゼンテーション、ドキュメントサイトをカバーします。

図と数式

文書を意識した構文で図や数式を制御できます。クイックスタートでは、画像サイズ、キャプション、単独図、インライン数式とディスプレイ数式のためのTeX数式構文が説明されています。

エージェント向けワークフロー

付属のエージェントスキルとオフラインwikiを使って、支援付きの執筆ができます。ブログでは、Quarkdownにはエージェント向けのスキルと、参照用のwikiおよびAPIリファレンスのオフラインコピーが同梱されていると述べられています。

利用例

  • 学術執筆とレポート作成

    ページレイアウト、図、数式を制御しながら、Markdownで論文やレポートを下書きできます。paged文書タイプは、従来型の文書出力とPDF書き出し向けに位置付けられています。

  • ドキュメントとナレッジベース

    docs風のレイアウトとサイドバー ナビゲーションを使って、社内Wiki、ナレッジベース、静的ドキュメントサイトを構築できます。この形式は、大規模なナレッジベースやWikiに適しているとされています。

  • プレゼンテーションと講義

    別のプレゼンテーションツールに切り替えずに、スライド資料や講義用教材を作成できます。slides文書タイプは、インタラクティブなプレゼンテーションや講演向けです。

  • ノートと個人ナレッジ管理

    NotionやObsidianのようなノートアプリに近い、連続フローのレイアウトでメモを管理できます。plain文書タイプは、知識管理やWeb閲覧に適していると説明されています。

  • プレビューから公開までのワークフロー

    ライブプレビューとCLIのコンパイルループで素早く反復し、完成した結果をHTMLまたはPDFへ書き出せます。これは、1つのソース形式でプレビューと公開を行いたいユーザーに適しています。

Pros and Cons

Pros

  • オープンソースかつMarkdownベースで、多くのユーザーにとってなじみやすい執筆モデルです。
  • プレーンなノート、ページ型文書、スライド、ドキュメントサイトなど、複数の出力スタイルに対応しています。
  • 反復的な執筆のためのライブプレビューとコマンドラインコンパイルを備えています。
  • 関数、変数、画像サイズ指定、図、TeX数式など、文書固有の機能を追加できます。
  • AI支援の執筆をサポートするためのエージェントスキルとオフライン参照資料を提供しています。

Cons

  • 収集された価格ページは404のため、利用可能なソースではホスト型の価格、プラン、商用パッケージは確認できません。
  • クイックスタートは基本的な使い方をカバーしていますが、提供されたソース内のより広いドキュメントは部分的であるため、一部の機能や統合はここでは未確認です。

FAQ

Quarkdownではどのような文書を作成できますか?

Quarkdownは、Markdownに追加の組版・レイアウト機能を加えて文書を作成するためのシステムです。ソースでは、論文、プレゼンテーション、ナレッジベース、静的サイトが想定される出力先として挙げられています。

Quarkdownで新しい文書を作成するにはどうすればよいですか?

クイックスタートでは、コマンドラインでの作業手順が示されています。`quarkdown create` でプロジェクトを作成し、生成された `.qd` ファイルを編集してから `quarkdown c` でコンパイルします。さらに、`-p -w` によるライブプレビューと `--pdf` によるPDF書き出しにも対応しています。

Quarkdownはどのような文書レイアウトに対応していますか?

クイックスタートには、`plain`、`paged`、`slides`、`docs` が文書タイプとして挙げられています。これらは、それぞれ連続したノート、ページ区切りの文書、プレゼンテーション、ドキュメント形式のサイトに対応します。

Quarkdownは素のMarkdownだけを使いますか、それとも追加の構文がありますか?

ソースによると、QuarkdownはMarkdownを基盤にし、GitHub Flavored Markdownの拡張を含んでいます。さらに、独自の関数、変数、図、画像サイズ指定、TeX数式構文も追加されています。

価格情報はありますか?

ホームページとブログではQuarkdownはオープンソースであると説明されていますが、収集したソース内の価格ページは404になっているため、ホスト型の価格やプランの詳細はここでは確認できません。

Quick Facts

カテゴリー
組版システム
主な操作方法
コマンドラインワークフロー
ソースドメイン
quarkdown.com
文書タイプ
plain, paged, slides, docs
出力形式
HTMLとPDF
ライセンス/位置付け
オープンソース