Skip to content

Pre-Commit Hook for Markdown Generation #276

@Cakem1x

Description

@Cakem1x

Hi! Thanks for the great project. I use it a lot in my ROS packages.

I also love that I can get nice markdown from the yaml. However, I often forget updating the markdown file when I change the yaml.
Have you considered adding pre-commit hooks that do the markdown generation / ensure that markdown is up-to-date wrt. the params definition in the yaml file?

I have some hacky solution running for one of my projects, using pre-commit's repo: local. But a proper hook that is part of this (or related) repo would be nicer I think.
I would be up for providing a prototype / implement it, if desired.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions