search

mkdocs / mkdocs-click

An MkDocs extension to generate documentation for Click command line applications
https://pypi.org/project/mkdocs-click
Apache License 2.0
105 stars 15 forks source link

Respect clicks docstring `\b` and `\f` markers #59

Open DeadNews opened 1 year ago

DeadNews commented 1 year ago

\b:

https://click.palletsprojects.com/en/8.1.x/documentation/#preventing-rewrapping Rewrapping can be disabled on a per-paragraph basis by adding a line with solely the \b escape marker in it.

\f:

https://click.palletsprojects.com/en/8.1.x/documentation/#truncating-help-texts You can use the \f escape marker to have Click truncate the help text after the marker.

Ref: https://github.com/DataDog/mkdocs-click/issues/57 and https://github.com/DataDog/mkdocs-click/issues/58