Skip to content

Update Markdown formatting, global flags behavior#1

Merged
gavv merged 7 commits into
gavv:mainfrom
hugginsio:kh-markdown-and-flags
Jan 28, 2023
Merged

Update Markdown formatting, global flags behavior#1
gavv merged 7 commits into
gavv:mainfrom
hugginsio:kh-markdown-and-flags

Conversation

@hugginsio

Copy link
Copy Markdown
Contributor

This PR introduces the following changes:

  • Markdown: specify language (text) for fenced code blocks
  • Markdown: modify headings to increment one level at a time
  • Markdown: only generate the "Global Flags" block if global flags are present
  • Replace strings.Title with cases.Title, as the former was deprecated in Go 1.18

Thank you for your work on this package! It is excellent for generating single pages of documentation for CLI's built with Cobra.

In the absence of a CONTRIBUTORS file, please let me know if I need to make any code changes to follow your coding conventions or if I need to create a matching issue for this changeset.

@gavv gavv left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for PR! Here are a few comments.

Comment thread _example/_markdown.md
Comment thread _example/_markdown.md Outdated
Comment thread generate.go Outdated
Comment thread generate.go Outdated
@gavv

gavv commented Jan 28, 2023

Copy link
Copy Markdown
Owner

Thanks, LGTM!

@gavv gavv merged commit c86c6b0 into gavv:main Jan 28, 2023
@gavv

gavv commented Jan 28, 2023

Copy link
Copy Markdown
Owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants