search

EthicalSource / contributor_covenant

Pledge your respect and appreciation for contributors of all kinds to your open source project.
http://www.contributor-covenant.org/
Other
1.85k stars 1.15k forks source link

reStructuredText version #684

Open brunobritodev opened 4 years ago

brunobritodev commented 4 years ago

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

heitorPB commented 2 years ago

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.

CoralineAda commented 2 years ago

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 commented 2 years ago

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!

heitorPB commented 2 years ago

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?

thibgc commented 1 year ago

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.