Skip to content

Use reStructuredText over Markdown for documentation #973

Open
@yukiisbored

Description

@yukiisbored

Continuation from #972 (comment).

The reason for this is because:

  1. Obvious native support with sphinx
  2. Not as primitive as Markdown (directives, roles, etc)
  3. You're likely generate more issues with Markdown than reStructuredText (e.g Headings)
  4. Extensible

I'm open for everyone to put their opinions in this issue so we can discuss if this is a good idea or not. I personally do not like Markdown as much as asciidoc or reStructuredText because it's pretty unpredictable and I usually doubt a lot wheter it'll parse correctly or have horrible issues (or even worse, unnoticeable issues).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions