Skip to content

Find a replacement for MkDocs. #282

@sadiepowell

Description

@sadiepowell

Unfortunately it seems like MkDocs 1.x is abandoned and 2.x won't support extensions so we need to find a replacement.

There appears to be a community fork but I'm uncertain how maintained it is given the last commit was two months ago.

The current site builds fine and there's not really any issues but we should find something to migrate to.

Features we need:

  • Ability to have custom plugins so we can keep generating the docs from YAML.
  • Ability to pages as if they are templates (like we do with Jinja2 in .md files currently)auto
  • Support for admonitions and other Markdown extensions.

I'm wondering if we should just go back to Jekyll to be honest.

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussionDiscussion about the documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions