コンテンツにスキップ
Blume is now publicly available.
Blume
日本語
Esc
移動開く⌘Jプレビュー
このページの内容

ページ

content フォルダー内のファイルがどのようにページになるのか、そしてルーティングとナビゲーションが自動的に推論されるようにファイルを整理・命名する方法。

ドキュメントは Markdown ファイルと MDX ファイルが入ったフォルダーにすぎません。Blume は各ファイルをページに変換します。ルーティング、ナビゲーション、メタデータはファイルシステムから推論されるため、同期を保つべきマニフェストは存在しません。

コンテンツは コンテンツルート(デフォルトは docs/blume.config.tscontent.root で変更できます)配下に置きます。

Markdown と MDX

Blume は 2 種類のファイルをレンダリングします。

ページが文章だけの場合は .md を、コンポーネントやディレクティブが必要な場合は .mdx を使いましょう。切り替えはファイル名を変更するだけです。

ファイルとルート

各ファイルは、コンテンツルート配下のパスに応じてルートに対応付けられます。

ファイル ルート
docs/index.mdx /
docs/quickstart.mdx /quickstart
docs/guides/theming.mdx /guides/theming
docs/guides/index.mdx /guides

ネストしたフォルダーはネストしたルートになり、フォルダー内の index.mdx はそのフォルダー自体のページになります。

数値プレフィックスによる並び替え

ファイルやフォルダーの先頭に数字を付けると、サイドバーでの順序を制御できます。プレフィックスは URL から取り除かれるため、リンクを壊さずにページを並べ替えられます。

01-introduction.mdx  ->  /introduction
02-installation.mdx  ->  /installation

並び順には複数の階層があります。優先順位の完全なルールはナビゲーションを参照してください。

グループフォルダー

フォルダー名を丸括弧で囲むと、URL セグメントを追加せずに、そのページ群をサイドバーでグループ化できます。

docs/(internal)/security.mdx  ->  /security

これらのページはサイドバー上で「Internal」グループを共有しますが、URL は括弧のないフラットなままです。

下書き

ページを下書きとしてマークすると、本番ビルドからは除外しつつ、blume dev ではプレビューできます。

---
title: Work in progress
draft: true
---

blume build は下書きをスキップし、blume dev はレンダリングするので、公開前の作業を進められます。

コンテンツタイプ

すべてのページには タイプ があり、フロントマターの type フィールドで設定します(デフォルトは doc)。タイプを使うと、Blume はページのグループごとに異なる扱いができます。中でも重要なのは、blogchangelog のページがフィードにまとめられる点です。

---
title: v1.2.0
type: changelog
date: 2026-06-20
changelog:
  version: 1.2.0
  category: Features
---

タイプはファイルの置き場所とは独立していますが、慣例としてブログ記事は blog/ 配下に、changelog エントリーは changelog/ 配下に置きます。どちらも自動的に RSS フィードを取得し、changelog エントリーは生成された /changelog タイムラインにもまとめられます。それぞれの執筆方法についてはブログChangelogを参照してください。

フィード

Blume は、rss.types に列挙された各コンテンツタイプ(デフォルトは blogchangelog)について、ページが 1 つ以上あれば自動的に RSS フィードを生成します。フィードは /<type>/rss.xml で配信されます。

タイプ フィード
blog /blog/rss.xml
changelog /changelog/rss.xml

各エントリーに date を指定すると、項目が新しい順に並び、pubDate が付与されます。クォートなしの YAML 日付でも問題ありません。Blume が正規化します。

---
title: Introducing Blume
type: blog
date: 2026-06-22
description: Why we built a markdown-first docs framework.
---

フィードには絶対的なサイト URL が必要なので、deployment.site を設定してください。Blume はすべてのページに <link rel="alternate"> タグを追加するため、ブラウザーやフィードリーダーが自動的にフィードを検出します。各コンテンツタイプの執筆方法についてはブログChangelogを参照してください。

このページの内容

すべてのページには、見出しから自動的に生成される目次が付きます。画面が広い場合はコンテンツの横の固定サイドバーに表示され、狭い場合はページ上部の このページの内容 パネルに折りたたまれます。スクロールすると、読んでいるセクションの項目がハイライトされるので、長いページでも現在位置が常に分かります。

Blume は各見出しをスラッグ化してアンカーにするため、すべての項目がそのセクションへ直接リンクします。また、URL にスラッグを付け加えることで任意の見出しへディープリンクできます(.../my-page#getting-started)。

目次には ##### の見出し(H2 と H3)が並びます。そのレベルの見出しがないページには、単に目次が付きません。

次はどこへ

このページは役に立ちましたか?