Quick Start

Thank you for using OneMark. OneMark brings markdown support for OneNote. Let’s explore how to start.

Live Preview

OneMark use the feature: Live Preview, meaning that you could see content styles after you finish typing and press Enter key. Just try to type some markdown in OneNote, for example # Test, and press Enter, you would see how it works.

Markdown For OneMark

OneMark is using GitHub Flavored Markdown. Besides basic syntax such as headers/blockquote/list, it also supports task list/code block/LaTeX/table of content/footnote, etc. If you are new to markdown, you can view the full markdown referrence. Here we will introduce some common syntax and special usage.

Block elements

Blockquotes, code blocks and LaTeXs are gracefully supported in OneMark. You can just type the syntax prefix, press Enter key, and you would see an edit block with background.

1
2
3

>      //blockquote
```java //code block
$$     //LaTeX

Then you can type in the block as usual. Pressing Enter will create a new line and trigger rendering in blockquote , or highlighting in code block. If you want to exit the block edit, press Ctrl + Enter.

Table

The table syntax in markdown is complicated and non-intuitive. Instead, OneNote already has a powerful set of table design. You can insert a table via Insert command tab, or just type some text and press Tab to create one. When you create a new cell with Tab, OneMark will render the last cell, just as what Enter does in plain paragraphs.

You can also paste markdown source of a table from other editor, then press F5 to render it.

Source Code Mode

Markdown source is hiddenly stored with every line in OneNote. You can switch current line to source code mode by shortcut Ctrl + ,, make some modifications, then press Ctrl + , again to render it back.

You can also directly modify a line in place without source code mode. OneMark will recognize those changes and update the source correspondingly, only when you need export markdown or switch to source code mode. That means **you can modify the note without OneMark, on any device. **This is so-called ‘bidirectional editing’.

Work with OneNote

When we design OneMark, we want it to blend into OneNote seamlessly and fit existed user experiences. We try to boost OneNote with modern editor designs and techniques, not build a separated markdown view. Thanks to live preview and bidirectional editing, we are almost getting there.

OneNote has some great basic designs which was ahead of its time, especially about lists and tables. You could use shortcut keys to easily create and manipulate them, sometimes more efficient than the markdown way. For example:

• Use Tab/Enter to indent lists.
• Use Tab/Shift + Tab to create table and navigate through cells.
• Use Alt + Shift + ↑↓ to move current paragraph or selections, or just drag the handle on the left.
• Use Ctrl + 1 to create a to-do.

Remember, markdown is just a choice of how to create formated content. After that, you can edit it in whatever way you want. Combine OneNote and OneMark, you will find your own efficient workflow.

Import/Export Markdown

OneMark can import markdown files created from other editors, including local images. You can also paste a piece of markdown source into OneNote and press F5 to render it.

If you want to export a note in OneNote to markdown format, press F8 and it will be generated and copied into clipboard. If you want to export to a .md file, click Export Markdown on the tab. Embedded images will be exported with the markdown file.

And More ?

For more questions or feedbacks, please contact us by onemark@neux.studio.

Enjoy!