skills.rest
frutik
frutikCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

kg-readme-writer

Synchronizes the repository README with the Awesome Search knowledge graph table of contents.

1.6k|143|Updated Sep 9, 2019
Search Tags:#obsidian#Markdown#documentation sync#wikilinks#quartz#ReadMe#Knowledge Graph
One-click install
npx skills add https://github.com/frutik/awesome-search --skill kg-readme-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: kg-readme-writer
Source: https://github.com/frutik/awesome-search/tree/main/claude-skills/kg-readme-writer
Command: npx skills add https://github.com/frutik/awesome-search --skill kg-readme-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeping a repository's README.md in sync with an evolving Obsidian knowledge graph is tedious and error-prone, especially when wikilinks must be converted to published-site URLs and history links must track the latest weekly notes.

Core Features & Use Cases

  • Targeted In-Place Edits: Updates the existing README.md with minimal Edit-tool replacements instead of regenerating the file from scratch.
  • Latest Changes Sync: Maintains a bullet list of the 5 most recent History week files sorted by year.week descending.
  • Wikilink Conversion: Converts Obsidian wikilinks from global_toc.md into vanilla markdown links pointing at the Quartz-published site, applying Quartz slugification rules.
  • Use Case: After adding or renaming notes in the Awesome Search vault, invoke the skill to bring the README's table of contents and history links back in sync, then verify no wikilinks leaked into the output.

Quick Start

Run /kg-readme-writer after making changes to the vault to sync README.md with the latest history files and global table of contents.

Frequently Asked Questions about kg-readme-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync a README with an Obsidian vault table of contents?▼

Read the existing README and the vault's global_toc.md, then apply targeted edits only to changed lines. Convert every wikilink to a vanilla markdown link pointing at the published site, and update the history section with the 5 newest week files.

How are Obsidian wikilinks converted to markdown links for a Quartz site?▼

Resolve each wikilink target to a note file under the vault, build the URL from its path relative to the published folder, and slugify each segment: whitespace becomes hyphens, & becomes -and-, % becomes -percent, and ? and # are deleted. Aliases become the display text.

Does this skill rewrite the README from scratch?▼

No. It modifies the existing README.md in place using targeted old_string/new_string edits. A full file is only created if README.md does not exist at all, and scripts are never used to rebuild it.

What happens when a wikilink target does not resolve to a note?▼

The display text is kept as plain text with no link, so no broken links are emitted. The unresolved names are reported to the user, since they usually indicate a renamed or missing note.

How do I verify no wikilinks leaked into the README?▼

Run grep -c '\[\[' README.md after editing; it must return 0. This confirms every Obsidian wikilink was converted to a vanilla markdown link or plain text.

Related Skills

Explore More Content & Communication Skills→
neverpreparedneverprepared

obsidian-publisher

Publish Markdown notes and Mermaid diagrams to Obsidian vaults.

Official
Intermediate
davidyohdavidyoh
2

obsidian-cloudflare-pages

Publish Obsidian markdown notes to Cloudflare Pages using Quartz.

Community
Intermediate
latticeHQlatticeHQ

generate-readme-screenshots

Regenerate README screenshots from Storybook stories using Playwright and Sharp.

Official
Advanced
lazygopherslazygophers
4

sect-system

Design martial arts sect hierarchies, lineages, rules, and culture for fictional worlds.

Official
Intermediate