Formatting - Linus-Mussmaecher/rucola GitHub Wiki

In general, Rucola and its HTML Conversion support all basic markdown syntax, as for example listed here. The used parser is comrak, so anything that is listed as supported there will be recognized by rucola.

In addition, rucola has some special syntax that is listed in the following subsections. Some of these are supported by comrak, others are parsed by rucola directly before passing the markdown file to comrak.

WikiLinks

Rucola supports links in the format [<name>|<target>] as well as [<target>] for linking to other notes, e.g.

A Lie Groupoid is a [[Groupoid]] in which all relevant maps are [[diffeomorphic|Diffeomorphism]].

Such links do not need to respect your folder structure - as long as the file is in rucolas search tree, it will be linked to.

Tags

Tags can be used to help categorize your notes, and are included in Rucola's statistics section. The format of a tag is a simple #<tag>, and you can create 'nested' tags with a slash as #<tag>/<subtag>. An example:

#math/topology
A *covering* is a special type of local homeomorphism.

YAML frontmatter

Rucola supports the inclusion of frontmatter in the YAML format. If you include a preamble of the form

---
title: <title>
tags:
  - <tag1>
  - <tag2>
    - <subtag2.1>
  - <tag3>
  - ...
---

in your note, it will not be passed to HTML conversion. Instead, rucola will use the given title as the name of your note (instead of the file name) and include the given tags in the note's statistics in addition to the ones found in the main body. You do not need to include both a title and tags. Including tags this way currently only support one level of subtags. It is possible to create multi-word tags this way, e.g. #interesting things. This is not possible with the usual markdown tags.

Math

By virtue of comrak and KaTeX, rucola supports including mathematical expressions in your code. Wrap them either in single dollar signs such as $<math>$ for inline math or double dollar signs such as $$<math>$$ for display math:

Let $X,Y$ be topological spaces. A function $f$ is called *continuous* if
$$
 \forall_{U \in \mathcal{O}(X)}\ f^{-1}(U) \in \mathcal{O}(Y) \text{.}
$$

Code

Enclosing a part of you note in triple backticks will render it as a codeblock.

⚠️ **GitHub.com Fallback** ⚠️