Start here
The main README is the tour: what the engine is, what it can do, and why it's built the way it is. This manual holds the guides that go deeper:
| Chapter | Answers |
|---|---|
| Getting started | How do I get from zero to a deployed site -- locally, on a VPS, on Cloudron, on Pages? |
| Writing, The archive, Running it | How do I run it day to day -- writing, deploying, cron, backup, troubleshooting? |
| Architecture | How does it work inside -- content model, build pipeline, deploy, client side, security? |
| Decisions | Why is it built this way -- the trade-offs, each with its admitted cost? |
| Importing | How do I bring an old blog in -- per-source guides, what gets kept, how to undo? |
| Skinning | How do I make it look like something else -- without forking the engine? |
| Localization | How do I translate the engine into my language? |
| Releasing | What has to be true before a tag, and what happens after it? |
Where to start, by situation
| Situation | Read |
|---|---|
| Evaluating the engine | main README → the screenshots → Why this exists → What it does |
| Setting up a site | Getting started, top to bottom |
| Writing and publishing posts | Writing → Writing and publishing |
| Dressing the site differently | Skinning -- try ./style.sh first; a skin is the expensive answer |
| Moving content in from elsewhere | Importing, then ./import.sh |
| Taking content out, or moving the whole site | The archive → Taking your content elsewhere, then ./blog.sh export |
| Checking that the archive itself is sound | The archive → Checking the archive, then ./blog.sh check |
| Something failed | Running it → Troubleshooting |
| Understanding the internals | Architecture, then the source -- every lib/ file opens with a design comment |
| Translating the engine | Localization -- a partial locale is useful from day one |
| Writing an importer | Architecture → Importing for the adapter contract, → Field reference for the schema to produce |
| Questioning a design choice | Decisions first -- it may already argue both sides |
The screenshot-*.png files here are the images embedded in the main README.