Kition
noteKnowledge Base

New Starter Wiki Page

A team wiki page for new starters whose contents list links to headings in the same note; one heading was renamed, so the kit's check reports the broken anchor.

New Starter Wiki Page — Note sample rendered by Kition

The contents list links to each section with same-note anchors (`[[#First day]]`). After the last edit the "Laptop and accounts" heading was renamed with `text.findReplace`, but the contents link still points at the old name: the kit's check reports `note.broken-anchor` on that line, and `links.list` marks the link's state. A sample about the problem, so the code is listed under `diagnostics`.

Steps

3 commands
showcase.yaml37 lines
steps:
  - command: note.write
    params:
      markdown: |
        # Welcome to the Studio

        Hello and welcome! This page is the first stop for everyone joining the design studio. #onboarding

        > [!INFO] Contents
        > - [[#First day]]
        > - [[#Laptop and accounts]]
        > - [[#Who to ask]]
        > - [[#Your first month]]

        ## First day

        Arrive at ten; Jun meets you at reception. The morning is a tour, coffee and lunch with your team. Bring a photo ID for your building pass.

        ## Laptop and accounts

        Your laptop is set up before you arrive. Sign in with the temporary password in the envelope, then change it straight away. Ask IT to add you to the design tools on your first morning.

        ## Who to ask

        | Question | Person |
        | --- | --- |
        | Building, desks, keys | Jun |
        | Accounts and laptops | IT desk |
        | Projects and priorities | Your lead |

        ## Your first month

        - Week 1: shadow a project review
        - Week 2: pair on a small brief
        - Week 4: present one thing you would change about how we work
  - { command: text.findReplace, params: { find: "## Laptop and accounts", replace: "## Equipment and accounts" } }
  - { command: links.list, params: { kinds: [wikilink] }, as: links }

Checks

6 checks on every build
  • inspect.headings = 5
  • inspect.links = {"wikilinks":4}
  • results.links.links = {"count":4,"any":{"anchor":"#Laptop and accounts","line":7,"state":"missing-anchor"}}
  • results.links.links.0 = {"anchor":"#First day","state":"resolved"}
  • Diagnostics: note.broken-anchor
  • The saved document opens again, and its thumbnail matches thumb.png within the render tolerance

Related

More Note samples
noteKnowledge Base

Sourdough Starter Guide

A knowledge-base article that links to neighbouring notes with wikilinks, warns and tips in callouts, cites a footnote and gives one paragraph a block id other notes can embed.

1 page; 236 words; 3 headings
noteKnowledge Base

Mechanics Revision Formulas

A revision sheet of mechanics formulas set as display and inline LaTeX math, with a worked example in a callout and a symbol table.

1 page; 134 words; 6 headings; 1 table
noteKnowledge Base

Reading List Tracker

A year's reading list kept as a Markdown table that grows row by row, with a status column, star ratings and a short reviews section.

1 page; 102 words; 3 headings; 1 table
noteTechnical Writing

Parcel Tracking API Reference

Developer documentation for a small REST API, with request and response code fences, parameter and error tables, and an anchor link to the errors section.

2 pages; 125 words; 5 headings; 2 tables