Skip to content

switch to mkdocs #49

Closed
Closed
@2bndy5

Description

@2bndy5

I'm not very happy with mdbooks output. I had to tweak it just to get the page ToC to display (which uses client-side JS on page load).

I believe it should be possible to switch to mkdocs and have an output very similar to cpp-linter/cpp-linter docs. The only hurdle is generating the CLI doc from rust souce code. For that, I'll probably use pyo3 + mkdocs-gen-pages.

Note

The version tags that correspond to when features were introduced could be retained.
image
But, there should be a heavy emphasis on the fact that anything before v2.0 would require a python runtime.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions