Workflow

A complete example

Combining everything so far, an article can look like this:

---
title: Trying Riebeckite
publish: true
---
 
# Trying Riebeckite
 
I built my first site with Riebeckite.
 
## What I used
 
- Markdown
- Riebeckite
- HonoX
 
## Related articles
 
The details are collected in [[configuration|the configuration article]].
 
## External links
 
[Riebeckite on GitHub](https://github.com/Rerurate514/riebeckite)

After the frontmatter, you can write the article as ordinary Markdown.

Check before publishing

After adding articles, run these commands from the site folder.

npm exec riebeckite check
npm exec riebeckite doctor
npm exec riebeckite dev

Use dev to preview the site in a browser and check the title, headings, body, links, images, and code blocks. When it looks good, build it.

npm exec riebeckite build

The roles differ:

If you use a plugin that diagnoses in-site links, it can also find internal links that point to pages that do not exist.

Checking which articles are recognized

If an article does not appear, use:

npm exec -- riebeckite inspect content --list

This shows which content Riebeckite recognizes. When an article cannot be found, checking in this order makes the cause easier to isolate:

content.directory
      ↓
exclude
      ↓
Recognized as content
      ↓
publish condition
      ↓
Public site

Build the site

Once the browser preview looks right, build the site.

npm exec riebeckite build

The basic flow is:

flowchart LR
    Write["Write Markdown"]
    Publish["publish: true"]
    Dev["Check with dev"]
    Check["check / doctor"]
    Build["build"]
    Deploy["Deploy"]
 
    Write --> Publish
    Publish --> Dev
    Dev --> Check
    Check --> Build
    Build --> Deploy