基本

記事を置く場所

標準では、記事を content/ に置きます。

my-site/
├─ content/
│  ├─ index.md
│  └─ first-post.md
│
├─ riebeckite.config.ts
└─ package.json

たとえば、

content/first-post.md

を作れば、Riebeckite が記事として読み込みます。

content/ 以外のフォルダを使うこともできます。既存の Obsidian Vault などを使いたい場合は Obsidian のノートをサイトにするガイドを参照してください。

最初の記事を書く

まず、

content/first-post.md

を作ります。

内容は次のようにします。

---
title: 最初の記事
publish: true
---
 
# 最初の記事
 
はじめての記事です。
 
Riebeckite で Markdown を公開してみます。

これだけで、公開できる最小の記事になります。

frontmatter

記事の先頭にある、

---
title: 最初の記事
publish: true
---

の部分を frontmatter と呼びます。

frontmatter には、本文ではなく、記事についての情報を書きます。

Markdown ファイル
│
├─ frontmatter
│    ├─ title
│    └─ publish
│
└─ 本文
     ├─ 見出し
     ├─ 段落
     ├─ リンク
     └─ 画像

最初は次の2つを覚えておけば十分です。

項目	意味
`title`	記事のタイトル
`publish: true`	この記事を公開する

たとえば、

---
title: Flutter を始めた
publish: true
---

なら、「Flutter を始めた」というタイトルの記事を公開します。

記事を公開する

既定の公開ルールでは、

publish: true

がある記事だけが公開されます。

公開する記事は、

---
title: 公開する記事
publish: true
---
 
この記事は公開します。

とします。

下書きにする

まだ公開したくない記事には publish: true を付けません。

---
title: まだ出さない記事
---
 
書きかけの記事です。

このファイルはコンテンツとして管理できますが、既定の公開ルールでは公開ページになりません。

Diagram source

flowchart LR
    Markdown["Markdown"]
 
    Markdown --> Publish{"publish: true?"}
 
    Publish -->|"Yes"| Public["公開"]
    Publish -->|"No"| Draft["公開しない"]

そのため、

content/
├─ published-post.md
├─ draft-post.md
└─ another-draft.md

のように、公開記事と下書きを同じ content/ に置いておくこともできます。

下書き（Draft）

Obsidian Vault

基本