Glossary
Every page and every other name for it. Each term has one home page.
- Command line
- Runs the commands check, fix, tree, model, and site. It is the only part that reads arguments and writes to the terminal.
- compatibility
- See Tested viewers.
- Configuration
- Reads idk-plans.config.json and fills in defaults. It also holds the JSON schema that editors use to check the file.
- Engine
- Reads the Markdown files, builds one model of all nodes, trees, and tasks, and checks and fixes the files from that model.
- Fix
- Writes the parts of each file that the tool owns: generated blocks, link paths, task marks, aliases, and tree tags.
- idk-plans
- Markdown
- Model
- Joins the parsed files into nodes and trees, calculates every rollup, and finds problems that need more than one file.
- Obsidian setup
- See Working in Obsidian.
- Obsidian support
- See Working in Obsidian.
- Parse
- Reads one Markdown file into facts: frontmatter, tasks, links, diagrams, and generated blocks. It does not look at other files.
- Prose unwrap
- Joins prose that is wrapped by hand into one line for each paragraph, so that viewers which show line breaks do not break sentences.
- Publish the site
- The site is a folder of static files, so any static host can serve it. This guide shows how to publish it from CI.
- Scan
- Finds the Markdown files that the configuration includes, and skips the files that it excludes.
- Site builder
- Builds a static website from the model, with diagrams that link to pages, a sidebar for each tree, search, and a list of open tasks.
- Specification
- The format of idk-plans files. It defines nodes, trees, tasks, rollups, links, generated blocks, and the checks.
- supported viewers
- See Tested viewers.
- Terminal
- Tested viewers
- The viewers that we test the Markdown files and the site with, and what each one shows differently.
- Viewers
- Working in Obsidian
- How to read and edit the docs in Obsidian, and how to work around the two places where Obsidian shows them wrongly.