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 the index:

• 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.

Command Line

The zl command line tool provides several subcommands for managing your Zettelkasten:

Global Options

• --verbose - Enable verbose output with additional details and ASCII art headers
• --version - Display the version number

index (alias: create)

Generate an index/reference file from your notes.

Options:

• -p, --path <path> - Root path for search (default: ".")
• -i, --ignore-dirs <path...> - Path(s) to ignore
• -r, --reference-file <path> - Path to output (default "reference.md")
• -c, --create-file <path> - Path to output file
• -m, --template-file <path> - Path to input mustache template (default "reference.md.mustache")
• -o, --show-orphans - Output list of orphaned links to console
• -t, --task-display <format> - Display tasks format: 'none', 'by-file', or 'by-priority' (default: 'by-file')
• --json-debug-output - Output JSON intermediate representations
• --no-wiki - Disable wiki-style links
• -v, --verbose - Show additional output

import (alias: sync)

Import notes from third-party sources. Will create new files or overwrite existing ones.

Trello API Key and Token

To import directly from Trello, you will need a Trello API key and (for private boards or board name lookup) a token:

1. Get your API key:

   • Visit https://trello.com/app-key while logged in to Trello.
   • Copy the API key shown at the top of the page.

2. Get your token:

   • On the same page, under "Token", click the link to generate a token.
   • Approve the access and copy the token provided.

Keep your API key and token secret! Do not share them or commit them to public repositories.

You can now use these with --trello-api-key <key> and --trello-token <token>.

Options:

• -s, --source <source> - Source type (e.g., trello, csv) Required
• -p, --path <path> - Search path, supports wildcards (default: ".")
• -o, --output-folder <path> - Folder to save notes to (default: "../import/")
• --trello-api-key <key> - Trello API key for direct board download (trello source only)
• --trello-board <idOrName> - Trello board id or name for direct download (trello source only)
• --trello-token <token> - Trello API token (required if using board name)
• --json-debug-output - Output JSON intermediate representations
• -v, --verbose - Show additional output

fix

Fix markdown files based on a set of rules. Will update existing files or output to a new directory.

Options:

• -p, --path <path> - Root path for search (default: ".")
• -i, --ignore-dirs <path...> - Path(s) to ignore
• -o, --output-dir <path> - Directory to output fixed files to. If not specified, files will be updated in place. (default: ".")
• -r, --rules <rule...> - Rules to use (default: all known rules)
• -m, --move - Move inline properties to frontmatter instead of copying (default: false)
• -v, --verbose - Show additional output

Existing Rules

• trailing-newline - Ensure files end with a single newline
• inline-properties-to-frontmatter - Ensure YAML frontmatter is correctly formatted, with inline properties moved to frontmatter if specified
  • If --move is specified, inline properties will be moved to frontmatter instead of copied
  • This is useful for moving Obsidian dataview properties to YAML frontmatter

notes (alias: update)

This has been DEPRECATED and will be removed in a future release. Please use zl fix instead.

Lint and fix notes markdown files. Will update existing files.

Options:

• -p, --path <path> - Root path for search (default: ".")
• -i, --ignore-dirs <path...> - Path(s) to ignore
• -w, --wiki-links-from-id - Convert [id]-style links into [[wiki-links]]
• -o, --show-orphans - Output list of orphaned links to console
• --json-debug-output - Output JSON intermediate representations
• --no-wiki - Disable wiki-style links
• -v, --verbose - Show additional output

Templating (for the index and import options)

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.