entangled-mkdocs

Generate annotated Markdown pages and update navigation for Entangled MkDocs sites.

5|3|Updated Jun 18, 2024
One-click install
npx skills add https://github.com/Unique-AG/ai --skill entangled-mkdocs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: entangled-mkdocs
Source: https://github.com/Unique-AG/ai/tree/main/.claude/skills/entangled-mkdocs
Command: npx skills add https://github.com/Unique-AG/ai --skill entangled-mkdocs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and assets (resource) components.

What problem does it solve?

This skill helps teams add and maintain documentation pages for MkDocs + Entangled sites by validating configuration, generating annotated Markdown pages, and updating navigation to reflect new content.

Core Features & Use Cases

  • Inspect MkDocs configuration and existing pages to ensure compatibility.
  • Generate Markdown pages with Entangled annotations, literate-programming prose, Mermaid diagrams when requested, and updated mkdocs.yaml/nav entries.
  • Extend docs with new pages for modules, features, or APIs, and register them in the Entangled registry.

Quick Start

Create a new Entangled MkDocs page by supplying a topic and confirm the project has MkDocs config and an entangled.toml.

Frequently Asked Questions about entangled-mkdocs

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

FAQPage Schema
How do I add new documentation pages to an MkDocs site using Entangled?

Adding new MkDocs pages with Entangled requires generating Markdown files with proper annotations and updating the mkdocs.yaml navigation. This skill automates that process by creating literate-programming prose, inserting Entangled tags, and registering code blocks in the entangled.toml watch_list.

What is literate programming in MkDocs and how does Entangled integrate with it?

Literate programming in MkDocs pairs explanatory prose with executable code blocks using Entangled annotations. This integration generates a registry to track code blocks and file targets, allowing documentation to serve as the source of truth while automatically tangling content into project files.

Do I need an entangled.toml file to use MkDocs for documentation generation?

Yes, an entangled.toml file is required alongside mkdocs.yaml or mkdocs.yml and a docs directory. This configuration satisfies prerequisites for watch_list versioning and enables the entangled plugin to tangle content from Markdown into actual code files.

Can I generate Mermaid diagrams in MkDocs documentation with Entangled annotations?

Yes, Mermaid diagrams can be generated within Entangled MkDocs pages. When creating new pages for modules, features, or APIs, you can request Mermaid diagrams alongside literate-programming prose, and the skill will integrate them into the annotated Markdown output.

Why are my Entangled code blocks not tracking correctly in MkDocs?

Incorrect tracking often occurs when the entangled plugin is missing from mkdocs.yaml or the registry is not properly generated. This skill validates your MkDocs configuration, inspects existing pages for compatibility, and ensures watch_list versioning in entangled.toml is correctly configured.

What is the best way to maintain Entangled MkDocs documentation across multiple modules?

Maintaining Entangled MkDocs documentation across modules requires consistent annotation citation and navigation updates. This skill extends docs with new pages for various modules or APIs, registers them in the Entangled registry, and automatically updates mkdocs.yaml nav entries to reflect new content.