search

callowayproject / bump-my-version

A small command line tool to simplify releasing software by updating all version strings in your source code by the correct increment and optionally commit and tag the changes.
https://callowayproject.github.io/bump-my-version/
MIT License
251 stars 18 forks source link

docs: monospaced section not parsed correctly #175

Closed irons closed 2 months ago

irons commented 2 months ago

Description

At https://callowayproject.github.io/bump-my-version/#visualize-the-pre_n-versioning-path, the depiction of show-bump output is parsed like a run-on sentence. The corresponding section at https://github.com/callowayproject/bump-my-version?tab=readme-ov-file#visualize-the-pre_n-versioning-path is OK.

The difference might be due to a leading space before the closing triple backticks at README.md:214. I tried to test that in a fork but ran out of time before I figured out how to get GitHub Pages to publish anything.

coordt commented 2 months ago

Thank you fr the feedback! It is rare to get any feedback on documentation. I appreciate it and will get it fixed today.