Documents are Markdown files stored locally on your device as a plain text. This way you have always an access to your data and don't have to worry about acreom not being here in future.

Working with documents

On top of the Markdown, documents provide additional functionality. This makes documents flexible to be used for variety of use cases.

You can access these features with the / command. For example you might want to use when you work on a feature or a project. When the feature is complete and you would like to create documentation for it, Mermaid & code blocks might come handy. Additionally, you can organise your knowledge base and projects by together.

See the sections below for additional context.

Code blocks

You can trigger code blocks with ``` quotes or using `

in a single line.

main :: IO ()
main = putStrLn "Hello, World!"

Mermaid

Mermaid is a core plugin in acreom which allows you to create flowcharts and diagrams using text and code.

Publish

Publishing documents is a PRO feature that is supported on Cloud Vaults only. Read more about creating a Cloud Vault in .

You can make any document publicly accessible with 1-click (top-right corner). This is useful if you need to share a document with someone else or create a public document like change log.

Creating backlinks with which are published makes it easy to create a wiki or a publicly accessible documentation (like this one!)

Converting data

With highlighting any text you can also convert it to any other data type like task, document or code block.

For a quick convert to, you can use CTRL+T shortcut to convert the higlighted text to task or CTRL+D to convert to document.

acreom automatically creates backlinks for converted documents so you can backtrack the context. This is especially useful if you use daily docs for a quick capture and branch out ideas and issues with converting to separate documents.

#tags

You can use to further organize your knowledge and group multiple documents by category. You can easily search by tags or find them in projects. To create a tag, simply use # followed by a text without space (space will trigger a markdown header)

Templates

Templates are useful when you need to capture information in consistent structure repetitively. For example, you might use a template for to keep your knowledge base consistent.

You can create templates in the following ways:

Make a selection within a Document and use the Convert menu to create a new template.
Right-click on any document and select “Create template”
Navigate to the Templates folder from Settings -> Templates, right-click anywhere within the folder, and select “Create new template”

To create a Document from template, you can either invoke the /templates command within a Document, or navigate to the Templates folder and create “New from template” by right-clicking on a template.

Elements containing temporal information such as are currently not supported in templates.

Quick Capture

Quick capture is a way to capture from anywhere within your system. To bring up quick capture, use the shortcut Ctrl + Shift + Space on Windows and ⌘ + Shift + Space on Mac. After capturing, the text will be added to the end of your My Day for the given day.

03. How to use acreom