Use fumadocs for documentation#6
Open
rafaeltab wants to merge 6 commits into
Open
Conversation
This file contains hidden or 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
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.
Preview: https://docs-mono-rafaeltab.vercel.app/
Hey! I setup a fully fledged hosteable documentation project for you.
If you don't want to use this feel free to close this PR, but it's a really nice framework for documentation that supports markdown and react at the same time (AKA mdx). I added some custom styles, and example pages to make it a bit prettier.
I also made a deployment in vercel for free so you can take a look what it looks and feels like here. You should notice that everything feels insanely fast, that is because it is :)
I included the tutorials you already wrote, but did not do anything with the other files, as I do not know your exact intentions with them? They can be embedded into the docs themselves, or kept where they are, or something else.
The framework is nextjs with fumadocs. Both are awesome, I really love fumadocs, and you can see their own documentation here, and one of my favorite projects that also uses it with highly customized styling here. You can also chat with the creator of fumadocs and one of the maintainers of the turbo docs.
You can add
md, ormdxfiles to the/docs/content/docsfolder to add new pages, it uses markdown frontmatter for the title, description, icon, and some other things. All the styles are fully customizeable if you want, though that does take effort that I did not want to put in yet :) You can also add full react pages, and even generate documentation from openapi specifications, and more.You can reach me on discord if you want to talk,
rafaeltabis my handle, I do also have x if you don't have discord (don't mind the cringe name that I chose years ago, and the cringe reposts of giveaways from when I didn't have a job yet).