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

Showcase usage of .MD format #560

Open
adiroiban opened this issue Nov 3, 2023 · 0 comments
Open

Showcase usage of .MD format #560

adiroiban opened this issue Nov 3, 2023 · 0 comments

Comments

@adiroiban
Copy link
Member

From #558 (comment)

We can try to have both a NEWS.rst and NEWS.md file, at the same time.

The NEWS.md can help with the content for the relese
We can also use build --draft --config towncrier-md.toml to generate MD format.

The idea is to do some dog food with Markdown format.

It can be tricky, as we should write the content for the news fragment in a format that is valid in both RST and MD... but I think that this can be done, as the content is not complex.

This can be implemented by having a towncrier-md.toml that will generate NEWS.md

we can run it as part of the release, before RST via build --keep --config towncrier-md.toml

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

No branches or pull requests

1 participant