contributor_covenant icon indicating copy to clipboard operation
contributor_covenant copied to clipboard

reStructuredText version

Open brunobritodev opened this issue 4 years ago • 5 comments

Actually many projects are using Read the Docs. It's a plataform to create docs, and make sense to provide there a Code of Conduct for those who want to contribute. But it uses reStructuredText (.rst) files. The syntax is little bit different from Markdown.

There are any plans to add a version with rst syntax?

If it's a desirable feature, I could provide it in English version

brunobritodev avatar Jul 10 '19 19:07 brunobritodev

Can't this be automated? It appears that Hugo automatically generates the asciidoc and txt from the Markdown file, it should be possible to also generate the rst. This would be very valuable for many projects.

heitorPB avatar Oct 01 '21 17:10 heitorPB

According to this page (https://gohugo.io/content-management/formats/) hugo can render RST files, but it requires an external helper. I'll check into whether that's possible in our deploy pipeline.

CoralineAda avatar Oct 01 '21 22:10 CoralineAda

From what I've read, I don't think it's possible with netlify. If someone wants to experiment, please open a PR and I can see if there's a way to make it work. Thanks!

CoralineAda avatar Oct 01 '21 22:10 CoralineAda

I thought the issue was about generating the rst from the markdown file? In a similar way that Hugo generates the asciidoc file and creates a link to download it.

Is it necessary to render the rst file in the end?

heitorPB avatar Oct 02 '21 17:10 heitorPB

Is it necessary that the reStructuredText version be generated automatically, or is it just nicer if it is? I'm happy to do a PR that marks up the 2.1 version into reStructuredText, it won't take long.

thibgc avatar Oct 14 '22 20:10 thibgc