djhackersdev / bemanitools

Runs recent Konami arcade games and emulates various arcade hardware.
The Unlicense
86 stars 17 forks source link

Have markdown "code" style and apply like clang-format in makefile #80

Closed icex2 closed 8 months ago

icex2 commented 3 years ago

Summary

Have a markdown style defined and allow applying it to the whole code base easily.

Detailed description

We don't have a consistent style for markdown. Some documents are ok/good to read, others aren't and there are a bunch of common best practices that are not followed everywhere.

Check if there is some tooling that allows us to implement this similar to what we already have with clang-format in the makefile.

Benefits

Aligned style in markdown files for consistency and improved readability and maintainability.

Drawbacks

None.

Current blockers

None.