Skip to content

Unique-AG/ai / .claude/skills/entangled-mkdocs

entangled-mkdocs

Verified

Add documentation pages to an existing MkDocs + Entangled site, explain how to serve locally, help adapt documentation

FileKindSize
SKILL.mdskill md19.6 KB
assets/mkdocs-baseline.yamlconfig4.1 KB
scripts/regenerate_registry.pyscript3.0 KB

assets/mkdocs-baseline.yaml

View on GitHub
# mkdocs-baseline.yaml
#
# Reference configuration for a MkDocs + Entangled documentation site.
# Use this as a starting point or to identify which extensions are missing
# from an existing project's mkdocs.yaml / mkdocs.yml.
#
# Required packages:
#   uv add --dev mkdocs-material mkdocs-entangled-plugin "entangled-cli>=2.0"
#   (or: poetry add --dev ...)
#
# After editing, preview with:
#   mkdocs serve   # the entangled plugin runs the tangle step automatically

site_name: My Project
docs_dir: docs

# Exclude internal files from the published site (requires MkDocs >= 1.5)
exclude_docs: |
  entangled-registry.json

# ---------------------------------------------------------------------------
# Theme
# ---------------------------------------------------------------------------
theme:
  name: material
  features:
    - content.action.edit        # "Edit this page" link
    - content.code.copy          # Copy button on code blocks
    - content.code.select        # Text selection in code blocks
    - navigation.indexes         # Section index pages (each section has index.md)
    - navigation.instant         # SPA-style page loads
    - navigation.sections        # Top-level sections always visible in sidebar
    - navigation.top             # "Back to top" button
    - toc.follow                 # Active TOC entry follows scroll position

# ---------------------------------------------------------------------------
# Markdown extensions
# ---------------------------------------------------------------------------
markdown_extensions:
  # Callout / admonition blocks: !!! note, !!! tip, !!! warning, etc.
  - admonition

  # Collapsible admonitions: ??? tip "Title"
  - pymdownx.details

  # Attribute lists: {.class #id attr=value}
  - attr_list

  # Footnotes: [^1] / [^1]: text
  - footnotes

  # Page-level YAML front matter (tags, hide, search)
  - meta

  # Code blocks with syntax highlighting and anchor line numbers
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true

  # Inline code highlighting: `#!python code`
  - pymdownx.inlinehilite

  # Fenced code blocks with custom fences (required for Mermaid and Entangled)
  - pymdownx.superfences:
      custom_fences:
        # Mermaid diagrams: ```mermaid ... ```
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  # Math notation (inline: \(...\), block: \[...\])
  # Do NOT use $...$ or $$...$$ unless explicitly configured
  - pymdownx.arithmatex:
      generic: true

  # Tabbed content: === "Tab 1"
  - pymdownx.tabbed:
      alternate_style: true

  # Task lists: - [x] done
  - pymdownx.tasklist:
      custom_checkbox: true

  # Emoji: :material-check:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

  # File inclusion: --8<-- "path/to/file.py"
  - pymdownx.snippets

  # Table of contents with anchor links on headings
  - toc:
      permalink: true

# ---------------------------------------------------------------------------
# Plugins
# ---------------------------------------------------------------------------
plugins:
  # Built-in search
  - search

  # Entangled literate programming — renders Entangled block annotations in HTML
  # Must be installed: pip install mkdocs-entangled-plugin
  - entangled

# ---------------------------------------------------------------------------
# Navigation (example — adapt to your project structure)
# ---------------------------------------------------------------------------
# Note: sections with a bare path (e.g. "- guides/index.md") act as section
# landing pages when navigation.indexes is enabled.
#
# IMPORTANT: Never modify !include monorepo entries or external URL entries.
# Example of entries to preserve unchanged:
#   - SDK: '!include ./unique_sdk/mkdocs.yaml'
#   - Changelog: https://github.com/org/repo/releases
# ---------------------------------------------------------------------------
nav:
  - Home: index.md
  - Guides:
    - guides/index.md
    - Getting Started: guides/start.md
  - Reference:
    - reference/index.md
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall