Zettel Markdown

Zettel files are written in Markdown, per CommonMark and GFM spec, along with most of commonmark extensions enabled.¹

Linking#
Zettel metadata#
Adding images and other files#
Styling elements using Semantic UI (#176)

Enriching Markdown:

Using raw HTML in Markdown#
Code Syntax Highlighting#
Math support#
Footnotes and many other extensions are enabled.
Highlighting: Surround text with == ... == to highlighting them (eg: This word is highlighted).

Neuron uses commonmark-hs to parse them into the Pandoc AST, as well as provides an extention on top to handle zettel links.
↩︎

Zettel ID
- A Zettel ID is a Zettel Markdown file’s filename¹ without the extension. Zettel IDs must be unique across the Zettelkasten.
  1. Neuron will NFC normalize the Zettel ID derived from filename or link so that they work reliably when using non-ascii characters in filename or links (see Linking#).
    ↩︎
Tutorial
- Neuron expects the Zettelkasten directory to contain a neuron.dhall, as well as a list of Zettel Markdown notes. By default, the current working directory will be used as your Zettelkasten directory (which you can override using the -d option). Create this directory first, and add a basic neuron.dhall (see Configuration file):

Guide#
- Basics: A neuron notebook is just a directory of Zettel Markdown files, which are identified by Zettel ID. Neuron transforms it into a Web interface, that is generated statically (self-contained HTML files). Advanced functionality are added via Plugins.
- Parent directory zettel