Troubleshooting

Checking the site

Once you have written an article, start the development server in the Riebeckite site directory.

npm exec riebeckite dev

Check the published article in the browser. To verify that there are no problems:

npm exec riebeckite check
npm exec riebeckite doctor

To see which content Riebeckite actually recognizes:

npm exec -- riebeckite inspect content --list

When an article does not appear

When an article does not appear, checking in the following order narrows down the cause.

flowchart TD
    Start["Article does not appear"]
 
    Start --> Dir{"Is the correct vault<br/>being read?"}
 
    Dir -->|No| Config["Check content.directory"]
    Dir -->|Yes| Excluded{"Is it excluded?"}
 
    Excluded -->|Yes| Exclude["Check content.exclude"]
    Excluded -->|No| Publish{"Is publish: true<br/>present?"}
 
    Publish -->|No| Frontmatter["Add frontmatter"]
    Publish -->|Yes| Diagnose["check / doctor"]

The resolved content directory can be confirmed with:

npm exec riebeckite inspect config

The content that was read can be confirmed with:

npm exec -- riebeckite inspect content --list

Everyday use

After setup, almost no special operation is needed.

flowchart TD
    Write["Write a note in Obsidian"]
    Decide{"Publish it?"}
 
    Decide -->|Yes| Publish["publish: true"]
    Decide -->|No| Private["Leave as is"]
 
    Write --> Decide
 
    Publish --> Dev["Check in Riebeckite"]
    Private --> Write
 
    Dev --> Push["Commit / Deploy"]

In other words, your everyday writing process stays almost the same. Write in Obsidian and add publish: true only to the notes you want to publish. Riebeckite uses that vault as the content source for the public site.