github1s icon indicating copy to clipboard operation
github1s copied to clipboard

Published 20 hours ago • verified publisher icon conwnet

[feature-request] Support for restructured text

Open purhan opened this issue 4 years ago • 2 comments

Many projects on github use RestructuredText (.rst) for their README. Example Is there a desire to add support for it?

purhan avatar Feb 11 '21 10:02 purhan

What are the benefits of using .rst in README?

Siddhant-K-code avatar Feb 21 '21 01:02 Siddhant-K-code

What are the benefits of using .rst in README?

@Siddhant-K-code It's generally preferred to use it for making API related docs. It has inbuilt features like Table of contents, symbolic mathematics, etc. Popular tools like sphinx use it for such reasons I believe.

purhan avatar Feb 21 '21 03:02 purhan