Quarkdown クイックスタートガイド

Markdown

Quarkdownとは

Markdown with superpowers - Markdownを大幅に拡張したスライド・文書作成ツールです。数式、グラフ、高度なレイアウトが簡単に作成できます。

前提条件

Java環境の確認・インストール

Quarkdownを動作させるにはJavaが必要です。

# Javaがインストールされているか確認
java -version

Javaがインストールされていない場合

  1. Oracle JDK(推奨)

  2. OpenJDK(無料版)

環境変数の設定

# システムのプロパティから設定
# Windows + R → sysdm.cpl → 詳細設定 → 環境変数
# JAVA_HOME: C:\Program Files\Java\jdk-17
# Path: %JAVA_HOME%\bin を追加

インストール方法

1. Quarkdown実行ファイルのダウンロード

# v1.3.3のzipファイルをダウンロード
# https://github.com/iamgio/quarkdown/releases/download/v1.3.3/quarkdown.zip

# 適切なディレクトリに解凍(例:C:\quarkdown)
# 環境変数PATHに C:\quarkdown\bin を追加

2. サンプルコードの取得

# プロジェクト用ディレクトリに移動
cd C:\Prj

# GitHubからサンプルコードをクローン
git clone https://github.com/iamgio/quarkdown.git

動作確認

インストール確認

# 新しいPowerShellウィンドウを開いて確認
quarkdown --help

サンプルスライドの実行

# クローンしたサンプルディレクトリに移動
cd C:\Prj\quarkdown\demo

# デモスライドを実行
quarkdown c .\demo.qmd -p

成功すると、ブラウザが自動的に開いてスライドが表示されます。

基本コマンド

# ヘルプの表示
quarkdown --help

# REPLモードで試す
quarkdown repl

# プロジェクト作成
quarkdown create my-project

最初のスライド作成

1. 新しいファイルの作成

任意のディレクトリで.qmdファイルを作成します
(内容はC:\Prj\quarkdown\demo\demo.qmdを参考)

2. スライドのコンパイル

# コンパイル&ブラウザで表示
quarkdown c your-file.qmd -p

# ファイル変更を監視(リアルタイム更新)
quarkdown c your-file.qmd -p -w

基本的なファイル構造

新しいプロジェクトの構成

my-project\
├── main.qmd           # メインのスライドファイル
├── images\            # 画像ファイル
├── assets\            # その他のリソース
└── output\            # 生成されたファイル

ファイル形式

  • ファイル拡張子: .qmd
  • 記法の詳細: 公式ドキュメントやデモファイルを参照

コマンドリファレンス

コンパイルオプション

# 基本コンパイル
quarkdown c file.qmd

# プレビュー付き(ブラウザで自動表示)
quarkdown c file.qmd -p

# ライブプレビュー(ファイル監視)
quarkdown c file.qmd -p -w

# 出力ディレクトリ指定
quarkdown c file.qmd -o output-folder

# クリーンビルド
quarkdown c file.qmd --clean

プロジェクト管理

# 新しい作業ディレクトリを作成
mkdir my-presentation
cd my-presentation

# 新規プロジェクト作成(インタラクティブ)
quarkdown create .

# REPLモード(試行用)
quarkdown repl

まとめ

Quarkdownは以下の手順で簡単に始められます:

  1. Java環境の準備: Java 17以上をインストール
  2. 実行ファイルの取得: リリース版をダウンロードしてPATHに追加
  3. サンプルコードの取得: GitHubからクローン
  4. 動作確認: デモスライドを実行
  5. 作成開始: 新しい.qmdファイルを作成

記法の詳細は公式ドキュメントやサンプルファイルを参考にしてください。

GitHub - iamgio/quarkdown: 🪐 Markdown with superpowers — from ideas to presentations, articles and books.
🪐 Markdown with superpowers — from ideas to presentations, articles and books. - iamgio/quarkdown

コメント

タイトルとURLをコピーしました