neko

Author the YAML frontmatter block of a Neko Markdown page — label, icon, order, tags, visibility, permalink, redirect, redirectSlug, layout, meta, nav, toc, backlinks, password. Use when configuring an individual page.

Author the project-level `neko.yml` — input/output paths, URL, branding, theme, meta tags, top navigation, banner, footer, snippets. Use when configuring or editing a Neko site at the project level.

Render a Mermaid diagram (flowchart, sequence, class, ER, state, gantt, journey, mindmap, sankey, XY, architecture) from a fenced ```mermaid``` block. Use for any structured diagram in docs.

Workflow for updating Neko documentation — base every page on the real source code, never invent APIs, warn loudly when the source isn't available, and check that the page (and any changed `tesserae` sample) renders correctly with Playwright / snapframe / a visual check. Use whenever you add or edit docs that describe code, APIs, components, or live samples.

Render a live Tesserae C# UI block — Neko compiles and executes the C# at build time and shows both the code and a working preview side-by-side. Use only when the project documents Tesserae or runs live C# samples.

Render C# API docs from a code block with XML doc comments (`/// <summary>`, `<param>`, `<returns>`, etc.). Use to embed API reference inline without a separate generator.

Format a fenced code block with syntax highlighting, optional title, line numbers, range highlighting, and macOS/Windows window chrome. Use whenever you write a multi-line code example.

Render a REST API endpoint reference entry (Microsoft Learn / Swagger style) — colour-coded HTTP method badge, monospace path, summary, and an Auth/Body/Returns details grid. Use for documenting REST endpoints in an API reference.

Build a timeline changelog page from a folder of version-named Markdown files. Mark the folder with `changelog: true` in its index.yml; name one file per release (v1.2.0.md). Use when documenting releases / "what's new".

Configure a folder's navigation behaviour with an `index.yml` — label, icon, order, expanded, visibility, permalink, nextprev. Use when shaping the sidebar tree.

Render a self-scoring multiple-choice comprehension quiz from a ```quiz fenced block. Single- or multi-answer questions, optional per-question explanations, scored client-side and stored in localStorage. Use to close a lesson or tutorial page with a knowledge check.

Declare an AI-generated image inline — Neko calls an OpenAI image model when the `neko gen-images` command runs, saves a PNG into the page's assets/img-gen/ folder, and rewrites the directive into a regular Markdown image with the original directive preserved as an HTML comment.

Render a short piece of code, a variable name, a file path, or any technical term inline within a sentence using backtick syntax. Renders as a styled pill with background and monospace font.

Render a lesson/curriculum header that auto-discovers sibling Markdown files as steps and tracks completion in localStorage. Use to build interactive courses, tutorials, and learning tracks.

Render a Neko Alert/Callout (admonition) block in Markdown — info, success, warning, danger, tip, question, primary, secondary, light, dark, ghost, contrast. Use whenever the user wants to highlight a tip, warning, note, or error inside docs.

Configure or place a Backlinks block — the list of pages that link to the current page. Use when the user wants to show inbound references or to disable the auto-appended backlinks section.

Render a Neko Badge — small inline label with optional variant, icon, size, corner style, and link. Use for tags, status pills, version markers, NEW/BETA flags, etc.

Configure the site-wide announcement banner shown above the header — text, link, colours, dismissibility, and version id. This is a neko.yml setting, not a Markdown component.

Render a Neko Button — a prominent clickable element with variant, size, icon, and link. Use for primary calls-to-action like "Get started", "Download", "Open dashboard".

Alias for Alert/Admonition — block that highlights important text with a coloured variant. Use the Alert skill; this entry exists so "callout" requests resolve.

Render Neko Card and card-grid blocks — content tiles with optional image, icon, title, tags, link, and palette. Use for landing pages, feature grids, navigation hubs.

Include source code from an external file (whole file, line range, or named region) with auto-detected highlighting. Use to embed real code from the repo without copy-pasting and risking drift.

Render a small color swatch with hex code or label. Use in design-system / palette documentation to preview colours inline.

Lay out content in equal-width columns using `|||`. Use for side-by-side comparisons, demo + source, before/after, two-pane layouts.

Show a paired install + quickstart command block with one-click copy. Use in getting-started pages or READMEs to highlight the two commands a new user needs.

Add hidden comments inside Markdown that don't appear in the rendered output. Use for TODOs, author notes, draft sections, internal review comments.

Wrap a chunk of Markdown in a `<div>` with custom CSS classes and HTML attributes. Use for layout helpers (center, max-width, background tint) and one-off styling without leaving Markdown.

Embed an external URL (iframe, video, CodePen, etc.) with optional caption, aspect ratio, dimensions, and fullscreen control. Use for live demos and third-party content that won't fit inline.

Insert an emoji with the `:shortcode:` syntax, or list every available emoji with `[!emoji-table]`. Use for friendly headings, status indicators, and decorative accents.

Side-by-side prose + code layout (description on the left, code on the right). Use to explain a code sample without losing the example next to its explanation.

Alias of the File component — same `[!file …]` shortcode rendered as a downloadable card. Use the File skill; this entry exists so "file-download" requests resolve.

Render a downloadable file card with icon, label, and optional file size. Use for attaching docs, PDFs, sample assets, archives.

Render an interactive force-directed graph from a simple node/link DSL or JSON. Use to visualise relationships, dependencies, knowledge graphs, mind maps.

Render a UIcon (Flaticon Regular Rounded) inline with `:icon-name:`, or use the same name in frontmatter `icon:` and component `icon=` attributes. Use for visual cues in headings, lists, badges, and navigation.

Embed an image with optional caption, title, dimensions, alignment, and HTML attributes. Use for screenshots, diagrams, hero images, inline figures.

Render bullet, ordered, task, alphabetic, roman, definition, and icon-prefixed lists. Use for any enumerated content; this skill covers Neko's list extensions on top of standard Markdown.

Render multi-line LaTeX formulas (aligned equations, matrices, cases) in a fenced `latex` block. Use for derivations and any math too large for inline `$…$`.

Render inline or block LaTeX math via KaTeX (`$…$`, `$$…$$`, `\(…\)`, `\[…\]`). Use for equations, symbols, and notation in technical docs.

Render a panel (titled box) or a collapsible accordion item. Use `===` for expanded panels, `==-` for collapsed. Stack adjacent panels for an accordion.

Embed a PDF inline using the standard Markdown image syntax. Neko auto-detects the `.pdf` extension and renders an inline viewer. Use for whitepapers, specs, and any printable references that should be readable on the page.