Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow setting of a default prefix for headings. #59

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MysterAitch
Copy link
Contributor

Fixes gh-56 / Closes #56

There is scope for overriding this per-heading (e.g. via the yml configuration) and adding a suffix (e.g. to allow for == header == style headings) but I figure let's start of with a smaller PR first 👍

@philwebb
Copy link
Collaborator

From #56 (comment)

Despite this, I cannot help but wonder if the idea of a prefix / heading level should be removed entirely, and just have it configured via the title itself - for example, to get level three headings:

That's certainly simpler, but I worry that it adds quite a bit of noise to the configuration. It would also break back-compatibility. I wonder if users want to mix heading levels in one output? We could look to see if the title starts with # and if it does we could skip applying the default?

@MysterAitch
Copy link
Contributor Author

MysterAitch commented Mar 22, 2021

I wonder if users want to mix heading levels in one output?

I can see a case for this -- for example, having most headings being level two, and the different categories of issue (bug, fix, etc) being nested inside another heading at level three.

(Or three and four, or whatever...)

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

Successfully merging this pull request may close these issues.

Allow specifying Markdown heading levels
2 participants