Use
This section follows a page from Markdown source to a reader’s successful task. Choose the workflow you actually use: file/Git authoring, the optional self-hosted browser editor, or administration of that editor. The generated static reader does not depend on a running writing server.
Write a complete task page
| Need | Start here |
|---|---|
| File-based authoring | Write documentation |
| Find and read a task | Reader experience |
| Enable browser writing | Optional editor |
| Work in the editor | Editor handbook |
| Manage writers and settings | Admin handbook |
| Understand stale changes | Save, publish and deploy |
Start with Authoring. It covers frontmatter, source paths/URLs, Markdown, local media, diagrams and content lifecycle. Build a synthetic Field Guide page with prerequisites, steps, expected results and failure checks.
Keep title-derived routes deliberate. Explain important code/diagram terms in prose for search. Verify the generated output rather than assuming valid Markdown or a browser preview proves the reader experience.
Understand the reader
Reader experience covers navigation, heading search, local state, code/diagram controls, mobile reading and acceptance checks. Test a page-title query, a heading query and direct deep-route reloads.
Hidden navigation is not privacy. Editor accounts protect writing; a private reader needs access control at its host. Keep sensitive inputs out of public content/static output.
Add browser writing only if you need it
Optional editor explains local activation, roles and operational boundaries. markstack.app is documentation only. Start the included editor on your own local/private installation.
Editor workflow covers source/preview, local drafts and file actions. Save writes source on the server. Drafts remain in the browser, and there is no general realtime merge or built-in per-page revision service.
Administer the writing installation
Admin console covers accounts/sessions, sections/pages, settings/header links, policy and history. Use separate role-specific tests, preserve writers’ unsaved work before access changes and inspect actual state before repeating a questionable operation.
For a team deployment, follow Run for environment-specific service, HTTPS, host/proxy, permission, backup and maintenance tasks. A local editor command is not a tested production deployment template.
Release the intended saved work
Save, publish and deploy distinguishes browser draft, server Markdown, built output, Git and remote hosting. Administrator Publish Changes builds a shared saved snapshot and switches local output; it does not silently push or upload.
The completion check is the actual reader: intended text/routes, working links/assets/search, readable narrow-screen output and correct old/missing-path behavior. When a page is stale, identify the first mismatched layer before repeating any operation.