CtrlK
CommunityDocumentationLog inGet started
Tessl Logo

tessl/pypi-mkdocs-awesome-pages-plugin

An MkDocs plugin that simplifies configuring page titles and their order through .pages configuration files

56%

Overall

Evaluation56%

0.95x

Agent success when using this tile

Overview
Eval results
Files

task.mdevals/scenario-2/

Explicit Navigation Task

Create documentation navigation that explicitly lists pages, directories, custom sections, and an external link for the existing docs tree:

  • docs/index.md
  • docs/overview.md
  • docs/guides/intro.md
  • docs/guides/advanced.md
  • docs/api/index.md plus any additional API pages in that folder

Use a .pages configuration file to define the navigation order and titles so the plugin picks up the structure without relying on automatic discovery. Enable the navigation plugin in mkdocs.yml (defaults are fine) so the .pages file is applied.

Capabilities

Build ordered top-level navigation

  • Navigation shows Home, Overview, Guides, API Reference, and Project Website in that order. @test
  • Top-level entries use the provided titles instead of filenames. @test

Group guides as a section

  • Guides appear as a nested section containing Getting Started (docs/guides/intro.md) followed by Deep Dive (docs/guides/advanced.md). @test

Include the API directory explicitly

  • Navigation includes the docs/api/ directory as API Reference, preserving its internal ordering (starting with index.md) without flattening into the root. @test

Add an external link

  • Navigation ends with an external link titled Project Website pointing to https://example.com/docs. @test

Implementation

@generates

API

# docs/.pages
nav:
  - Home: index.md
  - Overview: overview.md
  - Guides:
    - Getting Started: guides/intro.md
    - Deep Dive: guides/advanced.md
  - API Reference: api/
  - Project Website: https://example.com/docs

Dependencies { .dependencies }

mkdocs-awesome-pages-plugin { .dependency }

Provides .pages navigation processing to apply explicit entries for pages, directories, sections, and external links. @satisfied-by

tessl i tessl/pypi-mkdocs-awesome-pages-plugin@2.10.0

tile.json