菜单
Configure a folder's navigation behaviour with an `index.yml` — label, icon, order, expanded, visibility, permalink, nextprev. Use when shaping the sidebar tree.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
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.
基于 SOC 职业分类
| name | folder-index |
| description | Configure a folder's navigation behaviour with an `index.yml` — label, icon, order, expanded, visibility, permalink, nextprev. Use when shaping the sidebar tree. |
index.yml)A folder's appearance in the sidebar and its base URL are configured by an
index.yml placed inside the folder. The same keys work as page frontmatter,
just sitting in a .yml instead of being above content.
# guides/index.yml
label: Guides
icon: book
order: 100
expanded: true
| Key | Notes |
|---|---|
label | Sidebar text for the folder node. |
icon | UIcon, :emoji:, <svg>, or image path. |
order | Same rules as pages (higher number = higher position). |
expanded | true to expand the folder on initial load. |
visibility | public (default), hidden, protected, private. |
searchExclude | true to exclude every page in this folder (recursively) from the search index. |
permalink | Base URL for everything under this folder. |
changelog | true turns the folder into a changelog (version-named files → one timeline page). Pairs with title / description. |
nextprev.mode | show, hide, exclude for the whole folder. |
nav.mode | default, stack (per top-level folder). |
backlinks | Override project defaults inside this folder. |
Expand a folder by default:
expanded: true
Reorder a folder:
order: 1000 # near the top
order: -1000 # near the bottom
Re-base every page under guides/ to /tutorials/:
permalink: /tutorials
Protect a whole folder with the project password:
visibility: protected
Exclude every page in a folder from the search index:
searchExclude: true
You can put the same metadata on a folder's default page (index.md /
readme.md / default.md) instead of creating index.yml. They behave the
same; pick one to avoid confusion.
Prefix a folder with _ (e.g. _drafts/) to make Neko ignore it completely
— no visibility field needed.