Skip to content

Use fumadocs for documentation#6

Open
rafaeltab wants to merge 6 commits into
we-are-mono:masterfrom
rafaeltab:master
Open

Use fumadocs for documentation#6
rafaeltab wants to merge 6 commits into
we-are-mono:masterfrom
rafaeltab:master

Conversation

@rafaeltab
Copy link
Copy Markdown

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, or mdx files to the /docs/content/docs folder 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, rafaeltab is 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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant