Riebeckite
Menu
Color mode

First Content

This page shows how to make Markdown appear on your site. You can either edit the samples generated by starter or create a new file.

Where content lives

Generated sites read Markdown from content/ by default.

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

The starter preset already creates sample content. You can edit one of those files first; you do not have to create a new page just to verify that editing works.

By default, publishing is explicit: a Markdown file appears on the site only when its frontmatter has publish: true.

Edit an existing sample

Start the local preview if it is not already running:

sh
npm exec riebeckite dev

Open the local URL printed in the terminal. Then edit content/notes/writing.md or content/index.md and save. When the browser shows your changed text, Markdown editing is working.

Create the smallest page

Create content/first-post.md:

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

title is the page title. publish: true opts the page into the public site. The file name becomes part of the URL: content/first-post.md is served at /first-post, and index files serve the section root.

You can use regular Markdown. The starter preset also includes Obsidian-style Markdown support, so WikiLinks such as [[planning]] work with the generated sample notes.

See Writing content for frontmatter fields, drafts, images, and internal links.

Build

sh
npm exec riebeckite build

A successful build writes the publishable files to dist/.

If a page does not appear, first confirm that the dev server is running, the file is saved, and the frontmatter includes publish: true. For deeper investigation, use inspect content --list or doctor from the CLI reference.

Next

History

1 changesCollapseExpand
1 + ---
2 + title: First Content
3 + sidebar:
4 + label: First Content
5 + order: 30
6 + ---
7 + # First Content
8 +
9 + This page shows how to make Markdown appear on your site. You can either edit the samples generated by `starter` or create a new file.
10 +
11 + ## Where content lives
12 +
13 + Generated sites read Markdown from `content/` by default.
14 +
15 + ```text
16 + my-site/
17 + ├─ content/
18 + │ ├─ index.md
19 + │ ├─ guide.en.md
20 + │ ├─ examples.en.md
21 + │ └─ notes/
22 + │ ├─ planning.md
23 + │ └─ writing.md
24 + ├─ riebeckite.config.ts
25 + └─ package.json
26 + ```
27 +
28 + The `starter` preset already creates sample content. You can edit one of those files first; you do not have to create a new page just to verify that editing works.
29 +
30 + By default, publishing is explicit: a Markdown file appears on the site only when its frontmatter has `publish: true`.
31 +
32 + ## Edit an existing sample
33 +
34 + Start the local preview if it is not already running:
35 +
36 + ```sh
37 + npm exec riebeckite dev
38 + ```
39 +
40 + Open the local URL printed in the terminal. Then edit `content/notes/writing.md` or `content/index.md` and save. When the browser shows your changed text, Markdown editing is working.
41 +
42 + ## Create the smallest page
43 +
44 + Create `content/first-post.md`:
45 +
46 + ```md
47 + ---
48 + title: First post
49 + publish: true
50 + ---
51 +
52 + Hello from Riebeckite.
53 + ```
54 +
55 + `title` is the page title. `publish: true` opts the page into the public site. The file name becomes part of the URL: `content/first-post.md` is served at `/first-post`, and index files serve the section root.
56 +
57 + You can use regular Markdown. The `starter` preset also includes Obsidian-style Markdown support, so WikiLinks such as `[[planning]]` work with the generated sample notes.
58 +
59 + See [Writing content](../guides/writing-content.en.md) for frontmatter fields, drafts, images, and internal links.
60 +
61 + ## Build
62 +
63 + ```sh
64 + npm exec riebeckite build
65 + ```
66 +
67 + A successful build writes the publishable files to `dist/`.
68 +
69 + If a page does not appear, first confirm that the dev server is running, the file is saved, and the frontmatter includes `publish: true`. For deeper investigation, use `inspect content --list` or `doctor` from the [CLI reference](../reference/cli.en.md).
70 +
71 + ## Next
72 +
73 + - [Presets →](./presets.en.md)
74 + - [Deployment →](./deployment.en.md)
75 +