pelican-white-paper

Pelican White Paper

Pelican を使って Markdown を web にしてみましょう


🐍 Pelican とは

Pelicanは、Pythonで書かれた静的サイトジェネレーターで、ブログやドキュメントサイトを簡単に作成することができます。

📦 通常のインストール方法

Pelicanをインストールするには、以下のコマンドを使用します。 (仮想環境でインストールする:推奨)

uv tool install "pelican[markdown]"

または、推奨される依存関係を含めてインストールするには:

uv add typogrify

プロジェクト・ディレクトリ(/src)を作ります。

本来のインストール方法 /srcで次のコマンドを実行します

pelican-quickstart

📦 このリポジトリを利用する場合

当該プロジェクトのディレクトリで次を実行します (uvが導入されていることを前提にしています)

uv sync

📦 コンテンツ(Markdownファイル)を作成

作成したコンテンツは/src/contentに格納します

📦 pelican でマークダウンを変換

/srcで次のコマンドを実行します

pelican content

📦 プレビューしてみます

pelican --listen

🌐 公開してみます

Cloudflare Pages


📓 Pelican を学ぶ

Pelicanのドキュメント


ライセンス

MIT License

貢献

プルリクエストやイシューの報告を歓迎?します!

更新履歴

v0.1.0


GitHub Repository