Riebeckite
Menu
Color mode

Quick Start

This is the shortest path from an empty folder to a working Riebeckite site. You do not need to know the framework internals first.

Requirements

Brief requirements: Installation. You need Node.js (LTS), a terminal, and about 5 minutes.

1. Create your site

Run the interactive generator:

sh
npx create-riebeckite

Answer the prompts (recommended answers shown):

  • Project name — press Enter for the default my-site
  • Preset — keep starter when unsure; see Presets
  • Content source — choose This project so Markdown stays inside the site
  • Deployment — press Enter for Not now if you want a local project first. Choose Cloudflare Workers only when you want local publishing set up immediately. It installs dependencies and then asks Deploy now?: Yes publishes immediately, Later finishes the scaffold. Choose GitHub Actions to deploy on every push; see Deployment

When it succeeds, it prints Created a starter Riebeckite site in my-site and a short "Next steps" list. The local-first default does not deploy or install packages; move into the folder and install them:

sh
cd my-site
npm install

npm install installs the generated site's packages. The generated site is a single-repository project: the @riebeckite/* packages are published to npm, so this is all it takes.

The first files most people edit are content/index.md for content and riebeckite.config.ts for site.title, site.baseUrl, and content.directory.

2. Start development

sh
npm exec riebeckite dev

The development server is started by the generated app. Open the local URL printed in your terminal. If the Riebeckite site appears in the browser, this step is working.

Keep the command running while you edit. Press Ctrl + C when you want to stop it.

3. Edit the first page

Edit content/index.md. For example, change the heading to # My Digital Garden. Save the file and watch the browser update.

4. Create another page

Create content/hello.md with exactly this frontmatter:

md
---
publish: true
---
 
# Hello
 
This is my second page.

Served at /hello.

Add [[hello]] (Obsidian WikiLink) to content/index.md. The starter preset enables @riebeckite/plugin-obsidian-markdown; the generated content itself uses [[guide]], [[examples]]. Click through to verify the link works.

6. Build the site

sh
npm exec riebeckite build

A successful build writes the publishable static output to dist/. Deployment means hosting that folder.

7. Publish to Cloudflare Workers

A site generated with Cloudflare Workers already includes the Wrangler dependency and wrangler.jsonc, so no extra setup is needed. Build and publish:

sh
npm run build
npm exec riebeckite deploy

Choosing Yes at Deploy now? runs the build and deploy immediately after scaffolding and prints a URL like https://<name>.<account>.workers.dev. If you chose Later, or you want to publish later updates, run the two commands above. The first run opens a browser to sign in to Wrangler. For a site generated with Not now, install Wrangler first with npm install -D wrangler.

After the public URL is known, set site.baseUrl in riebeckite.config.ts to that URL, then build and deploy once more so generated URLs such as sitemap entries use the final address.

sh
npm exec riebeckite build
npm exec riebeckite deploy

To deploy automatically on every push, continue with GitHub Actions in Deployment. To keep content in a separate repository, see Separate Content Repository →.

Next

History

1 changesCollapseExpand
1 + ---
2 + title: Quick Start
3 + sidebar:
4 + label: Quick Start
5 + order: 10
6 + ---
7 + # Quick Start
8 +
9 + This is the shortest path from an empty folder to a working Riebeckite site. You do not need to know the framework internals first.
10 +
11 + ## Requirements
12 +
13 + Brief requirements: [Installation](./installation.en.md#requirements). You need Node.js (LTS), a terminal, and about 5 minutes.
14 +
15 + ## 1. Create your site
16 +
17 + Run the interactive generator:
18 +
19 + ```sh
20 + npx create-riebeckite
21 + ```
22 +
23 + Answer the prompts (recommended answers shown):
24 +
25 + - **Project name** — press Enter for the default `my-site`
26 + - **Preset** — keep `starter` when unsure; see [Presets](./presets.en.md)
27 + - **Content source** — choose `This project` so Markdown stays inside the site
28 + - **Deployment** — press Enter for `Not now` if you want a local project first. Choose `Cloudflare Workers` only when you want local publishing set up immediately. It installs dependencies and then asks `Deploy now?`: `Yes` publishes immediately, `Later` finishes the scaffold. Choose `GitHub Actions` to deploy on every push; see [Deployment](./deployment.en.md)
29 +
30 + When it succeeds, it prints `Created a starter Riebeckite site in my-site` and a short "Next steps" list. The local-first default does not deploy or install packages; move into the folder and install them:
31 +
32 + ```sh
33 + cd my-site
34 + npm install
35 + ```
36 +
37 + `npm install` installs the generated site's packages. The generated site is a single-repository project: the `@riebeckite/*` packages are published to npm, so this is all it takes.
38 +
39 + The first files most people edit are `content/index.md` for content and `riebeckite.config.ts` for `site.title`, `site.baseUrl`, and `content.directory`.
40 +
41 + ## 2. Start development
42 +
43 + ```sh
44 + npm exec riebeckite dev
45 + ```
46 +
47 + The development server is started by the generated app. **Open the local URL printed in your terminal.** If the Riebeckite site appears in the browser, this step is working.
48 +
49 + Keep the command running while you edit. Press `Ctrl + C` when you want to stop it.
50 +
51 + ## 3. Edit the first page
52 +
53 + Edit `content/index.md`. For example, change the heading to `# My Digital Garden`. Save the file and watch the browser update.
54 +
55 + ## 4. Create another page
56 +
57 + Create `content/hello.md` with exactly this frontmatter:
58 +
59 + ```md
60 + ---
61 + publish: true
62 + ---
63 +
64 + # Hello
65 +
66 + This is my second page.
67 + ```
68 +
69 + Served at `/hello`.
70 +
71 + ## 5. Link the pages
72 +
73 + Add `[[hello]]` (Obsidian WikiLink) to `content/index.md`. The starter preset enables `@riebeckite/plugin-obsidian-markdown`; the generated content itself uses `[[guide]]`, `[[examples]]`. Click through to verify the link works.
74 +
75 + ## 6. Build the site
76 +
77 + ```sh
78 + npm exec riebeckite build
79 + ```
80 +
81 + A successful build writes the publishable static output to `dist/`. Deployment means hosting that folder.
82 +
83 + ## 7. Publish to Cloudflare Workers
84 +
85 + A site generated with `Cloudflare Workers` already includes the Wrangler dependency and `wrangler.jsonc`, so no extra setup is needed. Build and publish:
86 +
87 + ```sh
88 + npm run build
89 + npm exec riebeckite deploy
90 + ```
91 +
92 + Choosing `Yes` at `Deploy now?` runs the build and deploy immediately after scaffolding and prints a URL like `https://<name>.<account>.workers.dev`. If you chose `Later`, or you want to publish later updates, run the two commands above. The first run opens a browser to sign in to Wrangler. For a site generated with `Not now`, install Wrangler first with `npm install -D wrangler`.
93 +
94 + After the public URL is known, set `site.baseUrl` in `riebeckite.config.ts` to that URL, then build and deploy once more so generated URLs such as sitemap entries use the final address.
95 +
96 + ```sh
97 + npm exec riebeckite build
98 + npm exec riebeckite deploy
99 + ```
100 +
101 + To deploy automatically on every push, continue with GitHub Actions in [Deployment](./deployment.en.md). To keep content in a separate repository, see [Separate Content Repository →](../guides/content-repositories.en.md).
102 +
103 + ## Next
104 +
105 + - [Deployment](./deployment.en.md) — publish to Cloudflare Workers and automate with GitHub Actions
106 + - [Presets](./presets.en.md) — compare `starter`, `minimal`, `showcase`, and `empty`
107 + - [First Content](./first-content.en.md) — write and preview content more deliberately
108 + - [Installation](./installation.en.md) — requirements and setup deep-dive
109 + - [Branding your site →](../guides/branding.en.md) — replace the icon, header logo, and link preview image
110 + - [Obsidian Vault →](../guides/obsidian.en.md) — use an Obsidian vault as content source
111 + - [Separate Content Repository →](../guides/content-repositories.en.md) — split content into a separate repo
112 +