Writing
Writing articles
Every article has a visual editor and a Markdown mode. Switch between them at any time; nothing is lost.
The visual editor
Type / for the block menu: headings, lists, tables, code blocks, images, callouts and more. Drag images or paste screenshots straight into the page; they upload automatically.
Markdown mode
Writers who prefer Markdown can use it end to end. HelpCenterKit supports GitHub-flavoured Markdown plus:
| You write | You get |
|---|---|
:::tip … ::: |
A tip callout (also note, info, warning, danger, success) |
::::tabs with :::tab{title="macOS"} |
Tabs, e.g. one per operating system |
| A YouTube, Vimeo or Loom link on its own line | An embedded video |
```bash |
A code block with syntax highlighting and a copy button |
Reuse content
Under Snippets & glossary you can save:
- Snippets: a block of Markdown you insert with
{{snippet:key}}. Change it once and every article updates. - Variables: a word or phrase such as a product name or price, inserted with
{{var:key}}. - Glossary terms: agreed definitions for your product's words, so the AI writer uses your terms consistently. AI can suggest terms from your articles.
- Templates: starting points for new articles, e.g. "How-to" or "Release notes".
Autosave and revisions
Drafts save as you type. Every publish creates a revision; open History to compare any two revisions line by line and restore an old one.
Product versions
If you document several versions of a product (v1 and v2), create versions under Snippets & glossary → Versions and assign articles and categories to them.