hackforla / hackforla/peopledepot

MkDocs plugin updates

Open
#678 0 comments 0 reactions 0 assignees View on GitHub
complexity: medium feature: docs: PD team documentation role: dev ops s: PD team size: 1pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

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

First brought up in https://github.com/hackforla/peopledepot/pull/677#issuecomment-4522977037

### 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

- copied from https://github.com/hackforla/peopledepot/pull/677#issuecomment-4522977037

> #### 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`](https://github.com/Johan-EU/mkdocs-awesome-autolinks) 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`](https://lukasgeiter.github.io/mkdocs-awesome-nav/migration-v3/), so we should probably switch to that too.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.