Color mode

Troubleshooting an external vault

Verification and troubleshooting

Run the CLI from a nested application directory to prove that configuration is not tied to the current working directory:

sh
cd site/app
npm exec riebeckite check
npm exec riebeckite doctor
npm exec riebeckite inspect config
npm exec -- riebeckite inspect content --list
npm exec riebeckite build
Diagram source
text
flowchart LR
    Check["1. check"]
    Doctor["2. doctor"]
    Config["3. inspect config"]
    Content["4. inspect content --list"]
    Build["5. build"]
 
    Check --> Doctor
    Doctor --> Config
    Config --> Content
    Content --> Build

Use the results in this order:

  1. check validates the config and plugin contracts.
  2. doctor reports an unreadable or invalid filesystem content source.
  3. inspect config confirms the resolved directory.
  4. inspect content --list confirms the expected logical paths before you diagnose a WikiLink or embed.
  5. build verifies the integration and route rendering.

If riebeckite.config.ts intentionally lives outside the Vite application, pass configRoot to riebeckiteVite(). Keep appRoot set to the site root and keep relative content.directory values relative to that root.

History

1 changesCollapseExpand
1 + ---
2 + title: Troubleshooting an external vault
3 + sidebar:
4 + label: Troubleshooting an external vault
5 + order: 80
6 + ---
7 +
8 + # Troubleshooting an external vault
9 +
10 + ## Verification and troubleshooting
11 +
12 + Run the CLI from a nested application directory to prove that configuration is
13 + not tied to the current working directory:
14 +
15 + ```sh
16 + cd site/app
17 + npm exec riebeckite check
18 + npm exec riebeckite doctor
19 + npm exec riebeckite inspect config
20 + npm exec -- riebeckite inspect content --list
21 + npm exec riebeckite build
22 + ```
23 +
24 + ```mermaid
25 + flowchart LR
26 + Check["1. check"]
27 + Doctor["2. doctor"]
28 + Config["3. inspect config"]
29 + Content["4. inspect content --list"]
30 + Build["5. build"]
31 +
32 + Check --> Doctor
33 + Doctor --> Config
34 + Config --> Content
35 + Content --> Build
36 + ```
37 +
38 + Use the results in this order:
39 +
40 + 1. `check` validates the config and plugin contracts.
41 + 2. `doctor` reports an unreadable or invalid filesystem content source.
42 + 3. `inspect config` confirms the resolved directory.
43 + 4. `inspect content --list` confirms the expected logical paths before you
44 + diagnose a WikiLink or embed.
45 + 5. `build` verifies the integration and route rendering.
46 +
47 + If `riebeckite.config.ts` intentionally lives outside the Vite application,
48 + pass `configRoot` to `riebeckiteVite()`. Keep `appRoot` set to the site root and
49 + keep relative `content.directory` values relative to that root.
50 +