Under the hood
These pages are for technical people: how a page is kept as a text file (markdown, with settings in YAML), what's in a vault's folder, and how to script Plicine from a terminal. You don't need any of it to use the app. Use Plicine is the door for that.
Everything here works with nothing but the app installed. The plicine command comes inside it: Plicine > Install Command-Line Tool… puts it in your terminal, and CLI reference says where it goes.
How it's stored
| Page | What it's for |
|---|---|
| Vaults | What's in the folder, and why Plicine writes next to nothing into it |
| Documents | The text format: markdown, frontmatter, block fences, links between documents |
| How blocks work | The kinds of block, how a name in a document finds the block that draws it, and blocks.lock |
| How themes work | What a theme is made of and how a document picks one |
| vault.json and frontmatter | Every setting a vault and a document can carry |
| Core blocks | Every field of page-break, toc, children, image, callout, card, columns and ts-block |
| Editing the source, and what the app writes | The Source view, and what each click in the app changes in the file |
| The app data folder | What Plicine keeps outside your vault, and what's safe to delete |
Scripting it
| Page | What it's for |
|---|---|
| CLI reference | Every command and flag |
| Template syntax and data | The full placeholder syntax, and filling templates from JSON |
| Exporting from the command line | export-pdf in scripts and CI, the render cache, identical output, choosing the browser |
| Sync, the lock file and the library | Conflicted-copy names, blocks.lock in a synced folder, one copy of a block for several vaults |
Vetting it
| Page | What it's for |
|---|---|
| Security | What Plicine protects, from whom, and the controls in place |