Inkdown Introduction

Inkdown Editor is a WYSIWYG editor and an LLM dialogue tool, fully compatible with GitHub Flavored Markdown Spec.

Inkdown strives to maintain a clean, beautiful, and user-friendly interface. In most cases, you don't need to read this documentation to get started, but you can still read this documentation to better understand Inkdown's features.

Data Storage and Conversion

Inkdown uses Sqlite as data storage to extend Markdown to some extent, because the original Markdown file may carry limited information. But you don't need to worry about this. Inkdown supports batch import of Markdown files and parses dependent images, links, and other resources. It can also sync to local folders in real-time, so you can still use any method for backup.

Inkdown output format is GitHub Flavored Markdown Spec, which is compatible with most platforms and editors.

Custom Shortcuts

Except for a few system shortcuts, you can customize any operation shortcuts. Open settings in the top-right menu or use the mod+, shortcut.

By default, you can paste any web content, and Inkdown will parse and insert it. Use mod+option+v to paste markdown code, and Inkdown will parse the Markdown and insert it. If you don't want to paste formatted text, you can use mod+shift+v.

Markdown

Use / at the beginning of a paragraph to quickly insert various elements. You can also use custom shortcuts, and some elements can be converted using syntax.

Use 1-4 # followed by a space at the beginning of a paragraph to convert it to a heading.

Use 1. or - followed by a space to convert a paragraph to a list.

Use ```[language] at the beginning of a paragraph to insert a code block, where language is the code language, such as js, python, etc. To support more language highlighting and editing performance, Inkdown uses Ace Editor for code components.

Use |text|text|text| to insert a 3-column table.

Links

You can use the floating toolbar to add links. Links can be any document in the space or web addresses. You can also use WikiLink syntax to add links. Many editors have implemented WikiLink syntax parsing, such as the famous Obsidian.

Images

You can use commands or directly paste images into the editor. Images will be saved in the Inkdown cache. You can clear unused images or download them in settings. When exporting space documents, image paths will be converted and images will be written to the export directory.

Formulas

Use $$ followed by Enter to insert a formula block. Formula blocks are rendered using Katex, as shown below:

$$c = \pm\sqrt{a^2 + b^2}$$

You can enable the use of the last $ symbol to convert inline formulas in settings.
For example, typing $c = \pm\sqrt{a^2 + b^2}$ will be converted to $c = \pm\sqrt{a^2 + b^2}$

Mermaid

You can also render mermaid diagrams by simply inserting a code block with the language set to mermaid. Inkdown will automatically render below the code block, like: