Markdown support

[JoergAtGithub]

The example-setups page in this PR is generated from MarkDown syntax instead of RST syntax: https://deploy-preview-712--mixxx-manual.netlify.app/chapters/example_setups

[daschuer]

This is a nice summary:
https://nikhilakki.in/markdown-vs-restructured-text

[daschuer]

What is the status here? Is this only about getting cross link check working?

[acolombier]

Looks like the links are actually working, only seems to get this false positive on the CI, perhaps some settings to tweak?

[JoergAtGithub]

What is the status here? Is this only about getting cross link check working?

This was a prove of concept how to use MarkDown as manual source for mapping pages instead of RST.
For the PoC I selected a page with many different elements and cross links from and to it. This is more than a mapping page will have (usually only links to other manual page but not in the opposite direction). As you can see, most RST formattings could be translated to MD syntax, but not all. The links work, but there I warnings, which I don't understood.

The idea in our monthly call was to store the MD files next to the controller mapping files, that the contributor needs only one PR to one single Repo. This MD file would than be syncronized to the manual repo, using the same process that we've already to get the changelog into the manual.

[acolombier]

Circling back on this, I have submitted a PR to make the Markdown version exactly equivalent to the look to the RST version and prove we can keep exact same feature (callout block, labels, glossary terms, ...)

I think this could be enough to merge this as is, so we can start consolidating the documentations allowing Markdown as alternative, and for example migrate the left over documentation from the Mixxx Github Wiki with a least amount of effort, using the Wiki repo (git@github.com:mixxxdj/mixxx.wiki.git)

Wdyt?

[acolombier]

There is some issue with Netlify, hopefully will be fixed soon

[acolombier]

Okay, Netlify fixed there issue. Preview is available here and reference page can be viewed in there

Note that the build is failing on unrelated warning.

[JoergAtGithub]

Now everything is working!

[acolombier]

Do you want to squash the fixups? I think this ready to go otherwise!

[JoergAtGithub]

Done!