Documentation pages are written in Markdown, with images and PDFs attached in place and diagrams drawn from a block of text.

Overview

The page editor has a Markdown toolbar. Headings, lists, tables, links, code blocks and bold or italic text all work as usual. HTML typed into a page is shown as text rather than run.

Three extras:

• Diagrams. A code block fenced as mermaid becomes a diagram.
• Attachments. Images and PDFs added in the editor are stored with the page.
• Links to records. A name in double square brackets, such as [[IT-00042]], links to that equipment, person, place or page. See Links between records.

The same Markdown, diagrams and links work in the What was done field of a change (see Change management).

Requirements

• Role: Write, archive and restore documentation (Admin, Manager and Technician by default).

Steps

Draw a diagram

1. Edit a page.

2. Start a block with three backticks and the word mermaid, write the diagram, and close the block:

   ```mermaid
   graph LR
     Office --> Firewall --> Switch
   ```

3. Click Save. The page shows the drawing in place of the text.

The diagram uses Mermaid syntax, so flowcharts (graph LR, graph TD) and Mermaid's other diagram types work.

Attach an image or a PDF

1. Edit a page.
2. Use the attach button in the editor toolbar, or drop the file into the editor.
3. Click Save.

Notes

Note: Attachments can be PNG, JPEG, GIF or WebP images, or PDFs, up to 10 MB each, or less if your plan's largest file is smaller. They are kept in TekStacks storage and count toward your plan's storage, even if you connect your own storage.

Note: Images load only from TekStacks. An image linked from another website shows as a plain link instead, so a page cannot track who reads it.

Troubleshooting

My diagram shows as text. Check that the block starts with exactly ```mermaid on its own line and is closed with three backticks.

An image from another site shows as a link. That is on purpose. Download the image and attach it to the page instead.

An attachment is refused for size. It is over 10 MB, over your plan's largest file, or would pass your plan's storage. The Billing page shows your plan's limits.