Skip to content

MkDocs plugin updates #678

Description

@fyliu

Overview

We need to update to mkdocs-awesome-autolinks and mkdocs-awesome-nav to improve our documentation infrastructure.

First brought up in #677 (comment)

Action Items

  • Replace autolinks with awesome-autolinks
  • Update awesome-pages to awesome-nav
  • See what improvements these plugins afford us and make those changes.

Resources/Instructions

Suggested changes

Switch autolinks to awesome-links

I'm looking at the autolinks plugin for mkdocs and it doesn't work very well with the awesome-pages plugin. The problem is it doesn't support multiple files named index.md in different directories, so I ended up specifying the full relative path, which defeats the purpose of the plugin.

There's another plugin called awesome-links that supports partial paths such as scripts/index.md and tools/index.md, which is better than autolinks

Update awesome-pages to awesome-nav

Looks like awesome-pages got renamed to awesome-nav, so we should probably switch to that too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    complexity: mediumStraightforward but some complexity (e.g., involves multiple files)feature: docs: PD team documentationdocumentation on PD team processes and architecture, etc.role: dev opss: PD teamstakeholder: People Depot Teamsize: 1ptCan be done in 4-6 hours

    Type

    No fields configured for Task.

    Projects

    Status
    🆕New Issue Review

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions