search

pyscaffold / pyscaffoldext-markdown

⬇️ PyScaffold extension which replaces reStructuredText by Markdown
https://pyscaffold.org
MIT License
12 stars 4 forks source link

Add a static CONTRIBUTING.md template #27

Closed abravalheri closed 3 years ago

abravalheri commented 3 years ago

This is an alternative implementation to address #18, while the issues with rst-to-myst still persist.

The template was generated by automatically converting PyScaffold's original RST templating via rst-to-myst CLI and then manually adjusting/improving it.

rst2myst stream ~/projects/pyscaffold/src/pyscaffold/templates/contributing.template \
    > src/pyscaffoldext/markdown/templates/contributing.template

For some mysterious reason, I did not manage to make Jinja2 substitutions even when the substitution myst extension is active in conf.py (which is very curious because it is working fine in the example I create when I opened the issue in rst-to-myst - see expected_option1.md)

The code in this PR is based on #25.

FlorianWilhelm commented 3 years ago

Thanks @abravalheri! I think that's perfect for the time being and the implementation is much easier.