< Back to help

Markdown

Markdown is a simple way to format text using special characters, allowing Diarly to store your entries as plain text. This guide will show you how to use Markdown effectively in Diarly, from basic formatting to creating links and managing Markdown visibility.

Why use Markdown in Diarly?

  • Avoids vendor lock-in: With Markdown, your files are easy to import and export, ensuring you can access your entries with any application in the future from a backup.
  • Efficient editing: Diarly supports automatic Markdown formatting using familiar shortcuts (⌘B for bold, etc.) or menus, and you can also manually input Markdown for hands-on keyboard formatting.

Basic Markdown Formatting

Markdown formatting can be applied to both lines and inline text.

Diarly - Markdown

Line Formatting

Apply line formatting at the start of a line. Key formats include:

  • Headers: Use # for a primary header, ## for a secondary header, and so on up to #### for a fourth-level header. Example: 
    # This is a main header
## This is a secondary header
### This is a tertiary header
#### This is a fourth-level header
  • Lists:
    • * for unordered lists.
    • 1. for ordered lists.
    • > for quotations.
    • [] for checklists, [x] for completed items. Use ⌘[ and ⌘] to adjust nesting, and ⌘ enter to toggle items.

Inline Text Formatting

Inline formatting can be applied to any part of the text:

  • Bold: **text**
  • Italic: *text*
  • Underline: __text__
  • Highlight: ::text::
  • Strikethrough: ~text~
  • Code or monospace: `text` (using the backtick key)

Creating Links

  • External links: Use [Link text](http://example.com) to link to external sites.
  • Wikilinks: Use [[Note Link]] for internal links within Diarly. Suggestions for entries appear as you type.

Managing Markdown Visibility

  • On Mac, navigate to Settings > Other Options and toggle Hide markdown syntax.
  • On iOS, go to More > Other Options and toggle Hide markdown syntax.

For more detailed formatting options and tips, refer to Diarly's Markdown guide or explore related help articles such as How to link between entries.