mkdocs-3-navigation-structure

Sub-skill of mkdocs: 3. Navigation Structure (+2).

5 stars

Best use case

mkdocs-3-navigation-structure is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Sub-skill of mkdocs: 3. Navigation Structure (+2).

Teams using mkdocs-3-navigation-structure should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/3-navigation-structure/SKILL.md --create-dirs "https://raw.githubusercontent.com/vamseeachanta/workspace-hub/main/.agents/skills/_internal/documentation/mkdocs/3-navigation-structure/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/3-navigation-structure/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How mkdocs-3-navigation-structure Compares

Feature / Agentmkdocs-3-navigation-structureStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Sub-skill of mkdocs: 3. Navigation Structure (+2).

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# 3. Navigation Structure (+2)

## 3. Navigation Structure


```yaml
# mkdocs.yml - Advanced navigation
nav:
  - Home: index.md
  - Getting Started:
      - getting-started/index.md
      - Installation:
          - Linux: getting-started/install-linux.md
          - macOS: getting-started/install-macos.md
          - Windows: getting-started/install-windows.md
          - Docker: getting-started/install-docker.md
      - Quick Start: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
  - User Guide:
      - guide/index.md
      - Core Concepts:
          - Architecture: guide/architecture.md
          - Components: guide/components.md
          - Data Flow: guide/data-flow.md
      - Tutorials:
          - Basic Tutorial: guide/tutorials/basic.md
          - Advanced Tutorial: guide/tutorials/advanced.md
          - Integration: guide/tutorials/integration.md
      - Best Practices: guide/best-practices.md
  - API Reference:
      - api/index.md
      - REST API: api/rest.md
      - Python SDK: api/python-sdk.md
      - CLI Reference: api/cli.md
  - Examples:
      - examples/index.md
      - Basic Examples: examples/basic.md
      - Advanced Examples: examples/advanced.md
  - Contributing: contributing.md
  - Changelog: changelog.md
  - License: license.md
```


## 4. Material Theme Features


```yaml
# mkdocs.yml - Theme customization
theme:
  name: material
  custom_dir: docs/overrides  # Custom templates
  logo: assets/logo.png
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      warning: octicons/alert-16
      danger: octicons/zap-16
      tip: octicons/light-bulb-16
      example: octicons/beaker-16

  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to light mode

  features:
    # Navigation
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.prune
    - navigation.indexes
    - navigation.top
    - navigation.footer
    # Table of contents
    - toc.follow
    - toc.integrate
    # Search
    - search.suggest
    - search.highlight
    - search.share
    # Header
    - header.autohide
    # Content
    - content.tabs.link
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tooltips
    # Announce
    - announce.dismiss
```


## 5. Admonitions and Call-outs


```markdown
<!-- docs/guide/admonitions.md -->

# Using Admonitions

MkDocs Material supports various admonition types for highlighting content.

Related Skills

repo-structure

5
from vamseeachanta/workspace-hub

Canonical source layout, test mirroring, root cleanliness, gitignore, docs classification, and committed artifact rules for all workspace-hub tier-1 repos. Consult before creating directories or files in any submodule.

tax-form-navigation-verification

5
from vamseeachanta/workspace-hub

Systematic workflow for verifying tax software calculations against entry guide specifications

tax-filing-payment-method-navigation

5
from vamseeachanta/workspace-hub

Navigate tax filing payment options while avoiding entry of sensitive financial data

github-issue-structure-for-personal-finance-tracking

5
from vamseeachanta/workspace-hub

Pattern for organizing financial analysis work across multiple repos (data/config vs. logic separation)

freetaxusa-upsell-and-payment-navigation

5
from vamseeachanta/workspace-hub

Navigate FreeTaxUSA's upsell pages and payment method selection flow while handling timeout dialogs and avoiding financial data entry

freetaxusa-tax-form-navigation-credits

5
from vamseeachanta/workspace-hub

Pattern for navigating FreeTaxUSA's tax form flow, validating auto-calculated credits, and handling form-specific exemptions

freetaxusa-eefile-navigation-pattern

5
from vamseeachanta/workspace-hub

Handling session timeouts and navigating FreeTaxUSA's multi-step e-filing flow to the signature page

repo-cleanup-structure-section-updates

5
from vamseeachanta/workspace-hub

Sub-skill of repo-cleanup: Structure Section Updates (+1).

discipline-refactor-target-repository-structure

5
from vamseeachanta/workspace-hub

Sub-skill of discipline-refactor: Target Repository Structure.

discipline-refactor-standard-folders-module-structure

5
from vamseeachanta/workspace-hub

Sub-skill of discipline-refactor: Standard Folders → Module Structure (+1).

mkdocs-with-title

5
from vamseeachanta/workspace-hub

Sub-skill of mkdocs: With Title.

mkdocs-warning

5
from vamseeachanta/workspace-hub

MkDocs warning admonition syntax. Use when alerting readers to potential issues or cautions in MkDocs documentation.