Correct way to convert clang-tidy .rst to .md correctly rendered by CodeChecker

[irishrover]

I'm trying to convert all the clang-tidy checks docs from .rst into .md compatible with CodeChecker markdown renderer (https://github.com/markedjs/marked).

All available .rst files for clang-tidy can be found here: https://github.com/llvm-mirror/clang-tools-extra/tree/master/docs/clang-tidy/checks

I apply pandoc this way:

> pandoc -t markdown_github -o bugprone-use-after-move.rst.md bugprone-use-after-move.rst

The result looks OK, but a bit simplified. What's the correct way to do this? Thanks.

[gyorb]

Hi, I did not try to convert them yet, but we do not use the github style markdown for the documentation. Did you try without giving any specific markdown type or with some other types (commonmark, markdown, markdown_strict) There is an example file but it was written long time ago by hand. What was not converted properly? Maybe something can be fine tuned on the markedjs side too where the html page is rendered.

[irishrover]

Hi. It's how rendered markdown_github is shown in a real browser and in CodeCheckere "Show Documentation" popup:

As you can see the code sections (CSS class fragment) look better in the browser.

[gyorb]

We can enable syntax highlight for the documentation too, it produces better output #1859