SkillFoxx

Mini-Wiki skill

A skill and CLI that turn a repository into a Markdown wiki with source links, search, a link graph and Obsidian views.

  • 114 ★ on the repository
  • Last commit
  • MIT
Skill

Extended access

Why this level

  • The CLI writes pages and a manifest into the repository `wiki/` and `.mini-wiki/` directories and moves retired pages into an archive.
  • Third-party plugins install disabled and only as instruction text.
All reasons and checks

trsoliu/mini-wikiAuthor:trsoliu

Install

In your terminal, with SkillFoxx CLI

npx skillfoxx add skills/mini-wiki

Detects the agents on your machine, shows the access level and pins the version.

Other ways to install

Access and checks

How we review

Extended accessThe tool runs code or makes network calls and only reads external data.

  • The CLI writes pages and a manifest into the repository `wiki/` and `.mini-wiki/` directories and moves retired pages into an archive.
  • Third-party plugins install disabled and only as instruction text.

This is third-party code. Review the repository files before installing.

What it does

Mini-Wiki 3.3 builds a verifiable Markdown knowledge network from a repository. Duties are split firmly: the CLI owns scanning, stable IDs, the graph, navigation, validation, search, the manifest, transactions and migration, while the AI agent writes evidence-based explanations inside protected regions of pages. Git keeps the history, and Obsidian stays an optional reading surface. The canonical wiki lives in the repository-level `wiki/` directory. The graph connects project, domains, modules, sources, symbols and documents. A rebuild keeps agent-written content and unknown user properties. Updates run as transactions with a dry run, and strict validation catches broken links, source drift and orphans. It includes local search that handles Chinese text, four Bases views for work queues and three Canvas maps of architecture, domains and traceability to sources.

Who it is for. Teams that need living project documentation tied to code, and developers who keep a knowledge base in Obsidian.

Good fit when

  • A new developer enters a large repository and needs a module map with links to source.
  • Documentation has gone stale and you need a drift check between the wiki and the code.
  • You want to read and search project knowledge in Obsidian without handing it control of the build.
  • You need a reproducible wiki rebuild with a dry run and rollback.

Not a fit when

  • The repository is a couple of files and needs no wiki.
  • You need external user documentation as a themed website.
  • The agent cannot write to the repository directory.

Example request

Build a wiki for this repository, validate in strict mode and fill in module explanations from the source.

Limitations

The CLI needs Python 3.10 or newer, installed from a clone with `python -m venv .venv` and `pip install -e .`. The agent writes the substantive explanations and their quality depends on the model: the CLI supplies structure and checks but does not guarantee the accuracy of the text. Pages without ownership markers are neither adopted nor overwritten. Obsidian commands work only when the app is installed, and `--probe` may start it. Third-party plugins install disabled and only as instruction text.

How to disable. Remove the skill through the skills manager and delete the `wiki/` and `.mini-wiki/` directories from the repository if the wiki is no longer needed. The CLI does not touch pages without ownership markers.

FAQ

Is Obsidian required?

No. Build, search, validation, Bases and Canvas work without it. Obsidian is only an optional shell for reading and browsing the graph.

How do I build the wiki?

Run `mini-wiki init`, then `mini-wiki build --dry-run --json` and `mini-wiki build --json`. After the build the agent fills the `mini-wiki:content` regions and rebuilds with validation.

What happens to text the agent wrote?

It is preserved byte for byte on rebuild: the agent writes inside `mini-wiki:content` regions, while generated navigation lives in separate regions.

How do I migrate from the old layout?

Use `mini-wiki migrate --json` to preview and `mini-wiki migrate --apply --json` to move. Migration backs up legacy material and switches configuration only after validating the result.

How do I search the wiki?

Run `mini-wiki search "query" --json`. Search is local, handles Chinese and mixed-language queries and accepts `--type`, `--tag` and `--limit` filters.

Discussion

No questions or reviews yet.

Skills

OpenWiki builds linked Markdown repository wikis, retains source evidence and lets agents search documentation across projects.

CLIExtended access17.9K

The CLI builds wikis from local or GitHub codebases, links modules and traces answers to source-file line ranges.

CLIExtended access306
Official

The official Kingsoft Docs (WPS) skill set: Claude Code and Codex create and edit cloud documents through kdocs-cli

SkillBroad access66
Russian stack

A Python MCP server and CLI for Yandex Wiki: create, read, update and delete pages by slug

MCP serverExtended access1

A skill that deep-reads a single paper and builds a structured Obsidian-style research note

SkillExtended access1.4K

The plugin compiles notes or codebases into a topic wiki with source backlinks and a user-approved article structure.

PluginExtended access331

Comparison with similar tools

Cards that share the main search query, and how they differ.

ToolOfficialAuthenticationRepository starsMain difference
Mini-Wiki (this card)no114
LLM Wiki Compilerno2,252compiles a wiki from knowledge sources; Mini-Wiki builds a repository graph tying pages to source code with strict drift checks
Deepwiki MCPnonot required1,392serves wikis from another service via MCP; Mini-Wiki creates the wiki inside your own repository

README in short

Version 3.3 moved the canonical wiki to the `wiki/` directory and introduced a stable repository graph, transactional builds and strict validation. State storage lives in `.mini-wiki/` and is rebuildable.

README badge

Original SKILL.md

---
name: mini-wiki
description: |
  Build and maintain a professional, source-traceable project knowledge network.
  Use when the user asks to generate, update, validate, search, migrate, or open a project Wiki;
  when architecture and module knowledge should be connected; or when Obsidian-compatible
  Properties, Bases, and Canvas views are useful. Durable Markdown lives in wiki/ and remains
  usable without Obsidian.
---

# Mini-Wiki 3.3.0

Mini-Wiki turns a repository into a versionable Markdown knowledge network. The CLI owns deterministic scanning,
graph construction, managed navigation, local search, Bases, Canvas, validation, and migration. The Agent owns the
professional explanations inside protected content regions.

For Chinese instructions, read `references/SKILL.zh.md`.

## Non-negotiable boundaries

- `wiki/` is canonical, durable knowledge. It should normally be committed.
- `.mini-wiki/` contains configuration, Manifest, cache, staging, and recoverable archives. Cache, staging, and
  archive are rebuildable local state.
- Markdown remains fully useful without Obsidian.
- Source references are repository-relative Markdown links. Never emit local URL schemes or absolute user paths.
- Never write or modify `.obsidian/`, themes, snippets, or Obsidian plugins.
- Obsidian detection is optional. Only an explicit `mini-wiki obsidian open` request may start the app.
- Third-party Mini-Wiki plugins are instruction-only. Read their `PLUGIN.md` or `SKILL.md` as text; never import,
  execute, or invoke plugin-provided scripts.
- Do not overwrite unmarked user documents. Do not edit content outside the ownership region assigned to the Agent.

## Agent workflow

Run the lifecycle in this order.

1. Initialize once:

   ```bash
   mini-wiki init <project>
   ```

2. Diagnose the project without launching Obsidian:

   ```bash
   mini-wiki doctor --json <project>

Report a problem