Notes and Markdown¶

Most items in dokuly have a Notes tab for writing free-form documentation. The editor supports GitHub Flavored Markdown with live preview, multiple tabs, and symbol/emoji insertion.

Using Notes¶

Navigate to any part, PCBA, assembly, or document and open the Notes tab. The default Main notes tab is pre-created for you.

To start editing, either click the Edit button or double-click anywhere in the text area.

Split View¶

Click Show Split View to see a live preview of your rendered markdown alongside the editor. This is useful for checking formatting before saving.

Multiple Tabs¶

Organize your notes into separate tabs for better structure:

Click the + button to create a new tab
Double-click a tab title to rename it
Right-click a tab to open the options menu (rename or delete)

Tip

Deleting a tab permanently removes all notes on that tab.

Markdown Support¶

The editor supports GitHub Flavored Markdown:

Headings — # H1, ## H2, ### H3
Bold — **text**
Italic — *text*
Lists — - item or 1. item
Code — `inline` or fenced blocks with ```
Links — [text](url)
Tables — standard markdown table syntax
Blockquotes — > text or use the blockquote dropdown to format selected text

Symbols and Emoji¶

Use the dropdown menus in the toolbar to insert standard symbols and emojis without typing them manually.

Where Markdown Works¶

Beyond the Notes tab, markdown is supported in most text fields throughout dokuly:

Revision notes and errata on parts, PCBAs, and assemblies
Issue descriptions
ECO descriptions
Requirement rationale and verification fields
Document descriptions