The goal is to rebump this project with a name that doesn't limit it to ROM Hacking, as it's a generic format conversion library.
Additionally, this library provides a lot of nice features but it doesn't have any documentation so it's hard to know about them or how to use it.
This PR provides new documentation website with modern look, explaining the features of the library with code snippets.
Used by many software projects for documentation
-Cons:
It forces to use MDX instead of pure markdown (even on .md files) causing several issues.
It will fail if you have HTML in markdown with open bracks (e.g. <br> generated by doc generators) or with some generics types if they are not in code blocks.
It runs with npm/react. It creates their typical chaos of environment of node_modules, vulnerable dependencies, version mismatches.
Fails with self linking (generated by most C# doc generators)...
No theming available apart from main one, it allows some CSS overrides.
Description
The goal is to rebump this project with a name that doesn't limit it to ROM Hacking, as it's a generic format conversion library. Additionally, this library provides a lot of nice features but it doesn't have any documentation so it's hard to know about them or how to use it.
This PR provides new documentation website with modern look, explaining the features of the library with code snippets.
TODO:
Tech selection - Site generator
Hugo Toha
Docusaurus
.md
files) causing several issues.<br>
generated by doc generators) or with some generics types if they are not in code blocks.PoC:
Statiq (before Wyam)
PoC:
DocFX
PoC:
Tech selection - C# docs as markdown
Note: not needed anymore as I will be using DocFX. Same if we were going to choose Statiq.
xmldoc2md
<br>
works with Docusuarus.ModularDoc
<br>
and some generic types without code blocks.Vsxmd
Example
Soon available at https://scenegate.github.io/Yarhl π
This closes #175