-
Notifications
You must be signed in to change notification settings - Fork 189
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
Convert our GitHub docs to MDX in Next.js #290
Comments
@seanprashad you're not on the assignees list for some reason so I'm tagging you here |
Sent @seanprashad an invite to be a collaborator on the repo. |
Mentioned by @humphd a while ago that this can be achieved using Gatsby as well. I will likely morph this into Gatsby markdown pages in the future instead of implementing docusaurus. |
Let's leave this for post 1.0 |
Find something similar to this https://material-ui.com/components/tabs/ for Gatsby... [Linux][Mac][Windows][instructions... ] |
Morph this into a bug about doing the same thing in next.js. cc @chrispinkney, related to #1463 for followup. |
Once #1463 gets resolved, I'd like to progress forward with this. After so many morphs, I think MDX with Next.js will be the one to actually get implemented. https://nextjs.org/blog/markdown looks promising. |
So because MDX is now landed this issue could be a lot of fun for whoever wants to work on it. NextJS can automatically generate routes for files found in the Also, this issue also depends on UI 2.0 as our docs that get rendered will need a touch up or sorts, thus I think this should go in after UI 2.0. |
@manekenpix Are you still curious about working on this? Anton has expressed interest in this today, maybe you guys would like to collab? |
Yes, definitely 👍 |
docusaurus is a neat way to organize and maintain markdown docs. It's used in many Facebook repositories and I think we could totally implement it in our project as well.
Here is an example from create-react-app:
All of their markdown documents show up like
https://create-react-app.dev/docs/getting-started
The text was updated successfully, but these errors were encountered: