Markdown

Live preview, reading view, references that know git, Obsidian syntax, and Mermaid.

Rip treats Markdown as a first-class file type. The preview renders while you type, follows your cursor, and knows about your repository.

Preview#

Press MCtrl+Shift+M to open the preview beside the editor. Press it again in the editor to close the preview. It renders again after each edit and scrolls to follow the cursor. Drag across rendered text to select it, then copy it with CCtrl+C. When the preview has focus, ↑↑, ↓↓, PgUpPgUp, and PgDnPgDn scroll it. Set markdown-preview = "split" to open every Markdown file with the preview.

Reading view#

Press VCtrl+Alt+V, and the tab itself becomes the rendered page. Press it again to edit. Set markdown-preview = "reading" to open notes this way.

What renders#

Rip renders GitHub Flavored Markdown: tables, task lists, and footnotes. Code fences in a language with a grammar get syntax highlighting in the editor and in the preview. File types lists the fence names. A fence with file=path lines=a-b renders those lines from the file on disk. A document can quote code that stays current.

Mermaid diagrams render as diagrams: flowcharts, state diagrams, sequence diagrams, and pie charts.

References that know git#

Mention a commit like e08ba37, a pull request like #12, or a merge request like !12 outside code blocks. The preview marks it with its status, such as merged, open, draft, closed, on branch, or not found. A request mention is also a link. On a task item, the chip also shows the title. Check a box in the preview, and Rip edits the source line.

Obsidian syntax#

Rip understands the syntax that Obsidian notes use:

• [[wikilinks]] with a bare name resolve to a file anywhere in the folder, except hidden or ignored files. A link with a path resolves as written.
• > [!tip] and the other callout types render as callouts.
• ==highlights== render as highlighted text.
• #tags render as tags.
• %%comments%% stay out of the preview.
• ![[image.png]] on a line of its own embeds the image.

The plan#

Press PCtrl+Alt+P to open your plan beside the code. Press it again from the plan to go back. Rip opens the file that plan-file names. Without that setting, it looks for docs/ROADMAP.md, ROADMAP.md, docs/PLAN.md, PLAN.md, and then TODO.md.

Keys#

Settings#