Riebeckite
Menu
Color mode

Getting Started

This section is the beginner path for publishing your first Riebeckite site. Follow it in order; advanced diagnostics, plugin development, and separate repositories are linked only when you need them.

text
Quick Start
    ↓
Installation
    ↓
First Content
    ↓
Presets
    ↓
Deployment

What is Riebeckite?

Riebeckite turns Markdown, including Obsidian-style notes, into a fast static site. You write Markdown in content/, run a local preview, build the output into dist/, and deploy that folder.

You do not clone this repository to use Riebeckite. The create-riebeckite generator creates a self-contained site for you.

Pages in this section

Page What you do
Quick Start Create, run, edit Markdown, preview, and build in one short path
Installation Check requirements and understand the generated files
First Content Write or edit your first published Markdown page
Presets Compare starter, minimal, showcase, and empty
Deployment Publish locally, then automate with GitHub Actions if needed
Use Your Obsidian Vault Connect an existing Obsidian Vault and publish selected notes
Add Your First Plugin Install a plugin and see ==highlight== syntax work
Change Your Theme Swap the theme and see the design change

The shortest path

sh
npx create-riebeckite

The CLI asks for the project name, preset, content source, and deployment. Keep starter, This project, and Not now to start locally, then:

sh
cd my-site
npm install
npm exec riebeckite dev

Open the local URL printed in the terminal. Edit Markdown in content/, make sure published pages have publish: true, then build:

sh
npm exec riebeckite build

To publish the build output as-is, install Wrangler and run npm exec riebeckite deploy; login and wrangler.jsonc generation are automatic. See Deployment for details.

If you are unsure which preset to choose, use the starter preset.

Developing Riebeckite itself? Start with Framework / Development instead.

Customize Riebeckite

Goal Guide
Already use Obsidian Use Your Obsidian Vault
Add features (search, diagrams, embeds…) Add Your First Plugin
Change appearance (colors, fonts, layout…) Change Your Theme
Replace the icon, logo, or link preview image Branding your site

Next

History

1 changesCollapseExpand
1 + ---
2 + title: Getting Started
3 + sidebar:
4 + label: Getting Started
5 + order: 10
6 + ---
7 + # Getting Started
8 +
9 + This section is the beginner path for publishing your first Riebeckite site. Follow it in order; advanced diagnostics, plugin development, and separate repositories are linked only when you need them.
10 +
11 + ```text
12 + Quick Start
13 + ↓
14 + Installation
15 + ↓
16 + First Content
17 + ↓
18 + Presets
19 + ↓
20 + Deployment
21 + ```
22 +
23 + ## What is Riebeckite?
24 +
25 + Riebeckite turns Markdown, including Obsidian-style notes, into a fast static site. You write Markdown in `content/`, run a local preview, build the output into `dist/`, and deploy that folder.
26 +
27 + You do **not** clone this repository to use Riebeckite. The [`create-riebeckite`](https://www.npmjs.com/package/create-riebeckite) generator creates a self-contained site for you.
28 +
29 + ## Pages in this section
30 +
31 + | Page | What you do |
32 + | --- | --- |
33 + | [Quick Start](./quick-start.en.md) | Create, run, edit Markdown, preview, and build in one short path |
34 + | [Installation](./installation.en.md) | Check requirements and understand the generated files |
35 + | [First Content](./first-content.en.md) | Write or edit your first published Markdown page |
36 + | [Presets](./presets.en.md) | Compare `starter`, `minimal`, `showcase`, and `empty` |
37 + | [Deployment](./deployment.en.md) | Publish locally, then automate with GitHub Actions if needed |
38 + | [Use Your Obsidian Vault](./obsidian-vault.en.md) | Connect an existing Obsidian Vault and publish selected notes |
39 + | [Add Your First Plugin](./first-plugin.en.md) | Install a plugin and see `==highlight==` syntax work |
40 + | [Change Your Theme](./first-theme.en.md) | Swap the theme and see the design change |
41 +
42 + ## The shortest path
43 +
44 + ```sh
45 + npx create-riebeckite
46 + ```
47 +
48 + The CLI asks for the project name, preset, content source, and deployment. Keep `starter`, `This project`, and `Not now` to start locally, then:
49 +
50 + ```sh
51 + cd my-site
52 + npm install
53 + npm exec riebeckite dev
54 + ```
55 +
56 + Open the local URL printed in the terminal. Edit Markdown in `content/`, make sure published pages have `publish: true`, then build:
57 +
58 + ```sh
59 + npm exec riebeckite build
60 + ```
61 +
62 + To publish the build output as-is, install Wrangler and run `npm exec riebeckite deploy`; login and `wrangler.jsonc` generation are automatic. See [Deployment](./deployment.en.md) for details.
63 +
64 + If you are unsure which preset to choose, use the `starter` preset.
65 +
66 + > **Developing Riebeckite itself?** Start with [Framework / Development](../framework/development.en.md) instead.
67 +
68 + ## Customize Riebeckite
69 +
70 + | Goal | Guide |
71 + | --- | --- |
72 + | Already use Obsidian | [Use Your Obsidian Vault](./obsidian-vault.en.md) |
73 + | Add features (search, diagrams, embeds…) | [Add Your First Plugin](./first-plugin.en.md) |
74 + | Change appearance (colors, fonts, layout…) | [Change Your Theme](./first-theme.en.md) |
75 + | Replace the icon, logo, or link preview image | [Branding your site](../guides/branding.en.md) |
76 +
77 + ## Next
78 +
79 + - [Quick Start →](./quick-start.en.md)
80 +