Color mode

First Content

Markdown をサイトに表示する方法を確認します。starter preset が生成したサンプルを編集しても、新しいファイルを作っても構いません。

content の場所

生成されたサイトは、既定では content/ の Markdown を読み込みます。

text
my-site/
├─ content/
│  ├─ index.md
│  ├─ guide.en.md
│  ├─ examples.en.md
│  └─ notes/
│     ├─ planning.md
│     └─ writing.md
├─ riebeckite.config.ts
└─ package.json

starter preset では、最初からサンプル content が生成されます。新しいファイルを作らなくても、まずはこれらの Markdown を編集して動作を確認できます。

既定では、frontmatter に publish: true がある Markdown だけが公開対象になります。

既存サンプルを編集する

まだ起動していなければ、ローカル確認用のサーバーを起動します。

bash
npm exec riebeckite dev

ターミナルに表示されたローカル URL をブラウザで開きます。次に content/notes/writing.md や content/index.md を編集して保存してください。ブラウザに変更した文章が表示されれば成功です。

最小のページを作る

content/first-post.md を作ります。

md
---
title: First post
publish: true
---
 
Hello from Riebeckite.

title はページのタイトルです。publish: true は、そのページを公開対象にする指定です。通常、content/first-post.md は /first-post として表示されます。index 系のファイルは、その階層のトップページになります。

本文は通常の Markdown で書けます。starter preset には Obsidian 風の Markdown support も含まれているため、生成されたサンプルノートでは [[planning]] のような WikiLink も使えます。

frontmatter、下書き、画像、内部リンクの詳しい書き方は Writing Content を参照してください。

ビルドする

bash
npm exec riebeckite build

成功すると、公開用のファイルが dist/ に作られます。

ページが表示されないときは、まず開発サーバーが起動しているか、ファイルを保存したか、frontmatter に publish: true があるかを確認してください。さらに詳しく調べる場合は、CLI reference の inspect content --list や doctor を使います。

次に読むページ

History

1 changesCollapseExpand
1 + # First Content
2 +
3 + Markdown をサイトに表示する方法を確認します。`starter` preset が生成したサンプルを編集しても、新しいファイルを作っても構いません。
4 +
5 + ## content の場所
6 +
7 + 生成されたサイトは、既定では `content/` の Markdown を読み込みます。
8 +
9 + ```text
10 + my-site/
11 + ├─ content/
12 + │ ├─ index.md
13 + │ ├─ guide.en.md
14 + │ ├─ examples.en.md
15 + │ └─ notes/
16 + │ ├─ planning.md
17 + │ └─ writing.md
18 + ├─ riebeckite.config.ts
19 + └─ package.json
20 + ```
21 +
22 + `starter` preset では、最初からサンプル content が生成されます。新しいファイルを作らなくても、まずはこれらの Markdown を編集して動作を確認できます。
23 +
24 + 既定では、frontmatter に `publish: true` がある Markdown だけが公開対象になります。
25 +
26 + ## 既存サンプルを編集する
27 +
28 + まだ起動していなければ、ローカル確認用のサーバーを起動します。
29 +
30 + ```bash
31 + npm exec riebeckite dev
32 + ```
33 +
34 + ターミナルに表示されたローカル URL をブラウザで開きます。次に `content/notes/writing.md` や `content/index.md` を編集して保存してください。ブラウザに変更した文章が表示されれば成功です。
35 +
36 + ## 最小のページを作る
37 +
38 + `content/first-post.md` を作ります。
39 +
40 + ```md
41 + ---
42 + title: First post
43 + publish: true
44 + ---
45 +
46 + Hello from Riebeckite.
47 + ```
48 +
49 + `title` はページのタイトルです。`publish: true` は、そのページを公開対象にする指定です。通常、`content/first-post.md` は `/first-post` として表示されます。`index` 系のファイルは、その階層のトップページになります。
50 +
51 + 本文は通常の Markdown で書けます。`starter` preset には Obsidian 風の Markdown support も含まれているため、生成されたサンプルノートでは `[[planning]]` のような WikiLink も使えます。
52 +
53 + frontmatter、下書き、画像、内部リンクの詳しい書き方は [Writing Content](../guides/writing-content.ja.md) を参照してください。
54 +
55 + ## ビルドする
56 +
57 + ```bash
58 + npm exec riebeckite build
59 + ```
60 +
61 + 成功すると、公開用のファイルが `dist/` に作られます。
62 +
63 + ページが表示されないときは、まず開発サーバーが起動しているか、ファイルを保存したか、frontmatter に `publish: true` があるかを確認してください。さらに詳しく調べる場合は、[CLI reference](../reference/cli.ja.md) の `inspect content --list` や `doctor` を使います。
64 +
65 + ## 次に読むページ
66 +
67 + - [Presets →](./presets.ja.md)
68 + - [Deployment →](./deployment.ja.md)
69 +