Improve Markdown code blocks & start moving docs to Markdown style (#19954)

- add additional parameters parsing (other implementations will just
  ignore them). E.g. if in RST we have:

  .. code:: nim
     :test: "nim c $1"

     ...

  then in Markdown that will be:

  ```nim test="nim c $1"
  ...
  ```

- implement Markdown interpretation of additional indentation which is
  less than 4 spaces (>=4 spaces is a code block but it's not
implemented yet). RST interpretes it as quoted block, for Markdown it's
just normal paragraphs.
- add separate `md2html` and `md2tex` commands. This is to separate
  Markdown behavior in cases when it diverges w.r.t. RST significantly —
most conspicously like in the case of additional indentation above, and
also currently the contradicting inline rule of Markdown is also turned
on only in `md2html` and `md2tex`. **Rationale:** mixing Markdown and
RST arbitrarily is a way to nowhere, we need to provide a way to fix the
particular behavior. Note that still all commands have **both** Markdown
and RST features **enabled**. In this PR `*.nim` files can be processed
only in Markdown mode, while `md2html` is for `*.md` files and
`rst2html` for `*.rst` files.
- rename `*.rst` files to `.*md` as our current default behavior is
  already Markdown-ish
- convert code blocks in `docgen.rst` to Markdown style as an example.
  Other code blocks will be converted in the follow-up PRs
- fix indentation inside Markdown code blocks — additional indentation
  is preserved there
- allow more than 3 backticks open/close blocks (tildas \~ are still not
  allowed to avoid conflict with RST adornment headings) see also
https://github.com/nim-lang/RFCs/issues/355
- better error messages
- (other) fix a bug that admonitions cannot be used in sandbox mode; fix
  annoying warning on line 2711
This commit is contained in:
Andrey Makarov 2022-07-15 20:27:54 +03:00 • committed by GitHub
commit 417b90a7e5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
47 changed files with 341 additions and 126 deletions

View file

@ -9,8 +9,13 @@ import ../../lib/packages/docutils/rst
import unittest, strutils, strtabs
import std/private/miscdollars
const
NoSandboxOpts = {roPreferMarkdown, roSupportMarkdown, roNimFile, roSandboxDisabled}
preferMarkdown = {roPreferMarkdown, roSupportMarkdown, roNimFile}
preferRst = {roSupportMarkdown, roNimFile}
proc toHtml(input: string,
rstOptions: RstParseOptions = {roPreferMarkdown, roSupportMarkdown, roNimFile},
rstOptions: RstParseOptions = preferMarkdown,
error: ref string = nil,
warnings: ref seq[string] = nil): string =
## If `error` is nil then no errors should be generated.
@ -47,9 +52,6 @@ proc optionListLabel(opt: string): string =
opt &
"</span></tt></div>"
const
NoSandboxOpts = {roPreferMarkdown, roSupportMarkdown, roNimFile, roSandboxDisabled}
suite "YAML syntax highlighting":
test "Basics":
@ -1180,7 +1182,7 @@ Test1
"input(8, 4) Warning: language 'anotherLang' not supported"
])
check(output == "<pre class = \"listing\">anything</pre>" &
"<p><pre class = \"listing\">\nsomeCode\n</pre> </p>")
"<p><pre class = \"listing\">\nsomeCode</pre> </p>")
test "RST admonitions":
# check that all admonitions are implemented
@ -1321,7 +1323,7 @@ Test1
That was a transition.
"""
let output1 = input1.toHtml(
NoSandboxOpts
preferRst
)
doAssert "<p id=\"target000\"" in output1
doAssert "<ul id=\"target001\"" in output1
@ -1543,7 +1545,7 @@ Test1
"""<td>text</td></tr>""" & "\n</tbody></table>")
test "Field list: body after newline":
let output = dedent """
let output = dedent"""
:field:
text1""".toHtml
check "<table class=\"docinfo\"" in output