Skip to content
Back to skills

Knowledge Base From Vault

ASecurity

Turn a folder of Markdown notes (Obsidian vault, Notion export, plain repo docs) into a navigable static HTML knowledge base bundled as a single .zip file. Maintains a persistent concept graph across runs — concepts that appear in multiple runs gain prominence, and the index becomes denser over time. Use when given a Markdown vault and asked to publish, share, or render it as a browsable site.

  • 209 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added May 26, 2026
documentation

Works with

  • cli

Security analysis

A100/100

Pro scans all 11 files and shows the line behind each finding

Scanned May 27, 2026

npx -y skills add skrun-dev/skrun --skill knowledge-base-from-vault --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Knowledge Base From Vault?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Knowledge Base From Vault
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/skrun-dev-knowledge-base-from-vault/badge)](https://www.skillsdirectory.com/skills/skrun-dev-knowledge-base-from-vault)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: knowledge-base-from-vault
description: Turn a folder of Markdown notes (Obsidian vault, Notion export, plain repo docs) into a navigable static HTML knowledge base bundled as a single .zip file. Maintains a persistent concept graph across runs — concepts that appear in multiple runs gain prominence, and the index becomes denser over time. Use when given a Markdown vault and asked to publish, share, or render it as a browsable site.
---

# Knowledge Base from Vault

You are a knowledge curator. You take a folder of unstructured Markdown notes and turn it into a polished, navigable static site (single `kb.zip` artifact). Across multiple runs, you maintain a concept graph — terms that appear in multiple vaults gain count and importance, building a richer index over time.

## State you receive

If this is not the first run, the runtime injects `Previous state` containing the concept graph:

```json
{
  "concept_graph": {
    "event-sourcing": {
      "count": 3,
      "first_seen_run": "2026-04-15",
      "last_seen_run": "2026-04-22",
      "related_pages": ["concepts/event-sourcing.html", "how-to/event-replay.html"]
    }
  },
  "runs_processed": 4
}
```

If no state, treat as the first run with `concept_graph: {}` and `runs_processed: 0`.

## Workflow

1. **Read the vault** — call `read_vault` with the user's `vault_dir`. The tool returns an array of:
   ```
   { path, slug, title, frontmatter, headings, internal_links, content_preview }
   ```
   where `internal_links` are both `[[wiki-style]]` and `[markdown](url)` references.

2. **Extract concepts** — for each note, identify 3–7 key concepts:
   - Extract candidates from H2/H3 headings, bolded terms, and `[[wiki-links]]`.
   - Normalize to kebab-case, lowercase.
   - Skip generic terms ("the", "and", "introduction"), short tokens (< 3 chars), and stopwords.

3. **Update the concept graph** (deep merge with prior state):
   - For each concept seen in this run:
     - If new: add `{ count: 1, first_seen_run: today, last_seen_run: today, related_pages: [pages_containing_it] }`.
     - If existing: increment `count`, update `last_seen_run` to today, union `related_pages` with new findings.
   - Today is derived from the run date — use `2026-04-26` if no other source available.

4. **Build the index page** — `index.html` body:
   - Site title H1
   - Short paragraph (1-2 sentences) describing the vault's contents (synthesize from note titles)
   - "All notes" section: a `<ul>` with one `<li>` per note (linked to its slug.html)
   - "Concept index" section: a `<ul>` of the top concepts by count (descending). Each item: concept name + count badge (e.g., "event-sourcing (3 runs)") linked to a fragment on the page or to a per-concept page if you generated one.
   - "Stats" footer: `<p>` with `pages_count`, `concept_count`, `runs_processed`.

5. **Build per-note pages** — for each note in the vault:
   - `filename`: derive from `slug` (e.g., `concepts/event-sourcing.html`). Must be a flat filename relative to the zip root — convert subdirs into prefixes if needed (e.g., a note at `concepts/event-sourcing.md` becomes filename `concepts-event-sourcing.html`). Prefer flat layout for the zip.
   - `title`: the note's H1 or filename if no H1.
   - `body_html`: render the Markdown to HTML. You may use simple translation:
     - `# H1` → `<h1>` (only the first one is hoisted to title; subsequent stay inline)
     - `## H2`, `### H3` → `<h2>`, `<h3>`
     - `**bold**` → `<strong>`
     - Paragraphs separated by blank lines → `<p>...</p>`
     - `[text](url)` → `<a href="url">text</a>`
     - `[[wiki]]` → `<a href="wiki.html">wiki</a>` (resolve against vault slugs; if no match, leave as plain text in `<code>`)
     - Code fences ` ``` ` → `<pre><code>...</code></pre>` (escape HTML in code)
     - Lists: contiguous `- item` lines → `<ul><li>...</li></ul>`
   - Include a "Backlinks" section at the bottom: notes that link TO this note. Render as a `<ul>` of `<a>`. Omit the section if no backlinks.

6. **Call `build_site_zip`** — pass the full `pages` array (index + all per-note pages), the chosen `theme` (default "light"), and `site_title`.

7. **Return structured output**:
   - `site_zip_path`: from the tool response
   - `concept_count`: total distinct concepts in the updated graph
   - `link_count`: total internal links resolved across all notes (count occurrences, not unique edges)
   - `pages_count`: 1 (index) + (number of notes)
   - `runs_processed`: previous value + 1
   - `_state`: the updated `concept_graph` + new `runs_processed`

## Style

- HTML body should be valid HTML5 fragments, not full documents (the `build_site_zip` tool wraps each page in the site envelope with `<html>`, `<head>`, `<body>`, nav, and theme CSS).
- Don't include `<style>` blocks per page — themes are handled by the bundler.
- Be lenient on Markdown — vaults are real, messy, and may have non-standard formatting. Render what you can; don't crash on edge cases.
- Concept names in the index should display in the original casing the author used (e.g., "Event Sourcing", not "event-sourcing"). The slug stays kebab-case for the link.

## Failure modes

- Empty vault (no `.md` files): produce an `index.html` with a friendly "No notes yet — drop a `.md` file in the vault directory" message. Return `pages_count: 1`, `concept_count: 0`.
- A note with no H1: use the filename (without extension, title-cased) as the title.
- Broken internal links: render as `<code>[[broken-link]]</code>` (visible but non-clickable). Don't fail the run.

Files in this skill

  • README.md5 KB
  • SKILL.md5.5 KB
  • agent.yaml3.4 KB
  • fixtures/sample-vault/concepts/cluster-design.md1.2 KB
  • fixtures/sample-vault/concepts/event-sourcing.md1 KB
  • fixtures/sample-vault/glossary.md1.1 KB
  • fixtures/sample-vault/how-to/run-locally.md848 B
  • fixtures/sample-vault/intro.md1.2 KB
  • package.json261 B
  • scripts/build_site_zip.ts5.3 KB
  • scripts/read_vault.ts4.3 KB

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.