Skip to content

Markdown doc rendering #1851

Open
Open
@alexespencer

Description

@alexespencer

Search before asking

  • I have searched the Supervision issues and found no similar feature requests.

Question

When viewing the docs in Github the syntax for the examples/how to guides is not valid markdown and code blocks do not render properly. When running mkdocs, it appears they do render properly. Is this the desired behaviour? It would be a nice experience for people viewing the project externally to not have to create an environment to view docs?

Additional

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions