Quarkdown: Markdownベースの動的組版ツール

Quarkdownは、CommonMarkとGitHub Flavored Markdown (GFM)の機能を拡張した、最新のMarkdownベースの組版ツールです。Quarkdownは、開発者、ライター、デザイナー向けに高速コンパイルとリアルタイムプレビューをサポートしています。Quarkdownは、開発者やライター、デザイナーのための高速コンパイルとリアルタイムのプレビューをサポートしています。ユーザーは、複雑なレイアウトを実現するためにシンプルなMarkdown構文を使用することができ、PDF出力とカスタムライブラリをサポートしています。このプロジェクトはオープンソースで、ドキュメントが充実しており、複雑なドキュメントを効率的に作成する必要があるユーザーのための活発なコミュニティがあります。

機能一覧

• 動的コンテンツ生成動的な挨拶や条件文のようなインタラクティブなコンテンツを作成するための関数と変数をサポートしています。
• リアルタイム・プレビュースルー -p 歌で応える -w コマンドを使用すると、コンテンツが自動的に更新され、ブラウザでライブ表示されます。
• PDF出力使用 --pdf コマンドは、ドキュメントを印刷可能なPDFファイルにコンパイルします。
• 標準ライブラリのサポートレイアウト作成、数学演算、条件文、ループなどの機能を提供。
• カスタム関数Markdownの機能を拡張するために、ユーザーは独自の関数や変数を定義することができます。
• 複数ファイルのコンパイルプロジェクト全体をコンパイルするためにルート・ファイルを指定します。
• インタラクティブREPLモードスルー quarkdown repl インタラクティブ・モードに移行して、コードを素早くテストする。
• 外部ライブラリのロードスルー -l もしかしたら --libs 機能拡張のために外部ライブラリをロードする。
• 複数のレンダリングターゲットHTMLやその他のレンダリングフォーマットをサポートし、柔軟なコンテンツ出力を実現。

ヘルプの使用

設置プロセス

Quarkdownはコマンドラインツールで、インストールは簡単です。以下はその詳細な手順です：

1. 環境の確保: QuarkdownにはNode.jsがインストールされている必要があります（最新のLTSバージョンを推奨）。実行 node -v Node.jsがインストールされているか確認する。
2. クローン倉庫GitHubのリポジトリ（https://github.com/iamgio/quarkdown）にアクセスし、以下のコマンドを実行してプロジェクトをクローンする：

   git clone https://github.com/iamgio/quarkdown.git
   

3. 依存関係のインストールプロジェクト・ディレクトリに移動して実行する：

   cd quarkdown
   npm install
   

4. グローバル・インスタレーションQuarkdownコマンドをグローバルに使用したい場合は、以下のコマンドを実行してください：

   npm install -g .
   

5. インストールの確認走る quarkdown --version インストールが成功したかどうかを確認する。

使用方法

Quarkdownはコマンドラインから操作します。 quarkdown c <file.qmd>これはMarkdownファイルをコンパイルするプロセスの最初のステップです。以下に主な機能と操作の流れを示します：

1.個々のファイルのコンパイル

Quarkdownファイルをコンパイルするには（例えば example.qmd)、走れ：

quarkdown c example.qmd

出力ファイルはデフォルトで ./output ディレクトリを指定します。出力ディレクトリを指定するには -o::

quarkdown c example.qmd -o ./my-output

2.リアルタイムプレビュー

Quarkdownはリアルタイムのプレビューをサポートしており、コンテンツを素早く調整するのに適しています。プレビューを開始するには、以下のコマンドを実行してください：

quarkdown c example.qmd -p -w

• -pブラウザのプレビューを起動し、デフォルトのブラウザを自動的に開きます。
• -wファイルの変更を監視し、自動的に再コンパイルします。
  合体 -p -w 保存後にプレビュー効果を即座に更新できるので、プレゼンテーションやウェブページを動的に調整するのに適しています。

3.PDFの生成

ドキュメントをPDFにエクスポートするには --pdf パラメーター

quarkdown c example.qmd --pdf

生成されたPDFファイルは出力ディレクトリに保存され、書籍の印刷やドキュメントの共有に適しています。PDF設定の詳細については、公式ドキュメント(quarkdown.com/docs)をご参照ください。

4.対話型REPLモデル

Quarkdown構文を素早くテストしたいですか？REPLモードを使用してください：

quarkdown repl

インタラクティブな環境に入れば、例えばクォークダウンのコードを直接入力することができる：

.function {greet} to from: **Hello, .to** from .from!
.greet {world} from:{iamgio}

出力結果はこうだ：Hello, world from iamgio!.このモードは学習やデバッグに適している。

5.標準ライブラリとカスタム関数の使用

Quarkdownは、レイアウト、数学演算、条件文をサポートする豊富な標準ライブラリを提供します。例えば、ダイナミックリストの作成：

.for {item} in {apple, banana, orange}:
- .item
.endfor

出力はこうだ：

• アップル
• バナナ
• オレンジ

ユーザーはカスタム関数を定義することもできる。例

.function {welcome} name: Welcome, .name, to Quarkdown!
.welcome {Alice}

出力：Welcome, Alice, to Quarkdown!.カスタム関数はライブラリとして保存でき、他のプロジェクトで再利用できる。

6.マルチ・ドキュメント・プロジェクト

複雑なプロジェクトの場合、Quarkdownは複数ファイルのコンパイルをサポートします。必ずルート・ファイル（例えば main.qmd)、自動的に他のファイルを含めます：

quarkdown c mock/main.qmd -p

サンプルプロジェクト mock Quarkdownの機能を学習するための様々なビジュアル要素が含まれています。

7.外部ライブラリの読み込み

外部ライブラリを使用する必要がある場合は、ライブラリ・ディレクトリを指定してください：

quarkdown c example.qmd -l ./my-libs

デフォルトのライブラリパスは <install dir>/lib/qmd.ユーザーは自分のライブラリを作成し、共有することができます。

8.レンダリングターゲットの設定

QuarkdownはデフォルトでHTMLを出力しますが、それは -r 他のレンダリングターゲットを指定する：

quarkdown c example.qmd -r html

その他のレンダリングオプションについては、公式ドキュメントを参照のこと。

注目の機能操作

• ダイナミックコンテンツQuarkdownの核となる機能は、関数と変数のサポートです。ユーザは .function 標準ライブラリのループと条件文を組み合わせて動的コンテンツを生成する関数を定義する。例えば、条件文の使い方：

  .if {condition} == true:
  Content displayed if true
  .else:
  Content displayed if false
  .endif
  

• 模擬例提供：クォークダウン mock ビジュアル要素とタイポグラフィ効果を実証するサンプルプロジェクト。実行 quarkdown c mock/main.qmd -p フルデモを見る
• 地域貢献ユーザはGitHubを通じてissueやプルリクエストを提出することで、機能開発に参加することができます。参考文献 CONTRIBUTING.md ガイドを手に入れよう。

その他の機能と詳細なドキュメントは、quarkdown.com/docsをご覧ください。

アプリケーションシナリオ

1. 技術文書
   開発者はQuarkdownを使用して動的な技術文書を作成できます。条件付きロジックや、関数や変数を介したループを使用して、複雑なドキュメントを作成できます。たとえば、APIドキュメントの表やリストを自動的に生成します。
2. インタラクティブ・プレゼンテーション
   教育者や講師は、Quarkdownを使ってインタラクティブなスライドショーを作成できます。リアルタイムのプレビューと迅速なコンテンツ調整を組み合わせて、教室や会議でのプレゼンテーションに活用できます。
3. ブックレイアウト
   著者はMarkdownファイルを自費出版や技術マニュアルに適した印刷可能なPDFブックにまとめることができます。PDF出力は幅広いトピックをサポートしています。
4. 個人ブログ
   ブロガーは、Quarkdownのダイナミック機能を活用して、ダイナミックな挨拶やパーソナライズされたコンテンツなどのインタラクティブな要素を含むウェブページを作成することができます。

品質保証

1. QuarkdownはどのようなMarkdown標準をサポートしていますか?
   QuarkdownはCommonMarkとGitHub Flavored Markdown (GFM)をベースに、関数、変数、標準ライブラリ機能で拡張されています。標準的なMarkdown構文は完全に互換性があります。
2. Quarkdownコードをデバッグするには？
   利用する quarkdown repl 対話型モードに入り、コードを一行ずつテストする。エラーメッセージがターミナルに表示されるので、問題を簡単に突き止めることができる。
3. プログラミングの経験は必要ですか？
   Quarkdownの構文はシンプルで、Markdownに慣れているユーザーはすぐに使い始めることができます。標準ライブラリとドキュメントが十分なサポートを提供します。
4. 異なるフォーマットをエクスポートするには？
   デフォルトの出力はHTMLです。 --pdf その他のレンダリングフォーマットは -r 詳細はドキュメントを参照のこと。
5. 地域社会に参加するには？
   GitHubリポジトリにアクセスして、課題やプルリクエストを提出してください。 CONTRIBUTING.md 貢献するためのガイドを手に入れよう。