New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
✨📚 New documentation website and project name re-meaning #192
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pleonex
changed the title
✨📚 New documentation website
✨📚 New documentation website and project name re-meaning
Sep 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
-Cons:
.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 typeswithout code blocks.
Vsxmd
Example
Soon available at https://scenegate.github.io/Yarhl 😉
This closes #175