zettel-lint

---

title: Readme references: [00000001] notes: YAML top matter is supported

---

If you are a coder and watch to submit a PR, please see the Contributor guide Contributor Covenant Code of Conduct.

If you are not a confident coder and would like to contribute please look at the task list. I will accept PRs that add issues from that file and update the md to point to them, so long as you at least do all the tasks in a section.

ZL

A linter/compiler for markdown-based Zettelkasten git repositories

Based on the Zettelkasten method

This is a link to a Page that doesn't exist

[[This is a link to a page that doesn't exist - an orphan]]

00000000 points back here

[ ] This is a task

[x] This completed task is ignored

• [ ] Also supports tasks in a bullet list
• [x] if they aren't completed

Tags can use #hashtag or +projectref formats for compatibility with todo.txt files

To refresh index:

• cd zle
• npm i
• npm run-script zl -- -r ../ -i "../zle/**" -r ../references.md

This will use the references.md.mustache as the template for the references file.

See example journal for the style of repo this could be used on.

Templating

Some features accept a mustache based template to generate their output. See references.md.mustache for an example.

For the indexer, there is a {{#notes}} collection with all notes, as well as a collection named after each collector.

Each collector looks for specific features:

• the WikiCollector looks for [[wiki]] [Markdown](example.com) and footnote local references and populates the {{#Links}} collection, where each file has outgoing links in the {{#data}} collection and incoming links in the {{#bag}} collection
• the TagCollector looks for #hashtag and +project references, and populates the {{#Tags}} collection
• the TaskCollector looks for [ ] Tasks or (A) todo.txt style, and populates the {{#Tasks}} collection
• the OrphanCollector looks for all wiki links with a URL, and populates the {{#Orphans}} collection
• the ContextCollector looks for todo.txt style @context links and populates the {{#Contexts}} collection

Each note has the following properties:

• id - the unique internal id (usually the timestamp from the filename)
• filename
• wikiname - filename without the last 3 characters, which turns a .md file into its wiki reference.
• title - taken from YAML top matter, the first # H1 header or the filename, in that order
• data - the collection of matches by this collector in this file

Template extensions

• {{``markdownEscaping}} Using the a single backtick at the start of the tag will escape any markdown characters into an HTML escaped version.
• {{?tag/filter/}}{{/?tag}} Using a ? at the start of a tag pair will filter any output using the specified regular expression. An empty filter will match everything.
  • {{?tag?sort(key)/filter/}}{{/?tag}} will sort the results according to the specified key, or alphabetically by name if the key name is not supplied.