Convert markdown documentation to reStructuredText

haskell / haskell-language-server

Official haskell ide support via language server (LSP). Successor of ghcide & haskell-ide-engine.

Apache License 2.0

2.61k stars 353 forks source link

Convert markdown documentation to reStructuredText #3663

Open cgeorgii opened 1 year ago

cgeorgii commented 1 year ago

Motivation

Markdown is great but lacks some interesting features:

Importing source code with literalInclude
Admonition boxes
etc.

Proposed solution

Ideally all markdown files in the docs/ directory could be converted to reStructuredText.

Additional context

This issue originated from a comment.

michaelpj commented 1 year ago

I don't think we should do this wholesale: the markdown files are easier for people to contribute to. But using RST where it provides useful additional power is sensible.