Add documentation site #24
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
- The latest fumadocs update adds a tailwind prefix, so it doesn't conflict with Shadcn/ui anymore. We can use a single `tailwind.config.ts` file now.
MFarabi619
force-pushed
the
mfarabi/feat/23-add-documentation-site
branch
4 times, most recently
from
7425d10
to
3f1e49d
Compare
MFarabi619
force-pushed
the
mfarabi/feat/23-add-documentation-site
branch
from
3f1e49d
to
fd4dc79
Compare
MFarabi619
force-pushed
the
mfarabi/feat/23-add-documentation-site
branch
from
fd4dc79
to
21dcd6d
Compare
HasithDeAlwis
previously approved these changes
Aug 3, 2024
MFarabi619
commented
Aug 4, 2024
| @@ -0,0 +1,4 @@ | |||
| /** Auto-generated */ | |||
There was a problem hiding this comment.
This is generated at build time. It essentially creates a 'map', as per the file name, of all the docs pages so that they can be looped through by the loader and rendered.
ngc
approved these changes
Aug 4, 2024
| @@ -0,0 +1,4 @@ | |||
| /** Auto-generated */ | |||
| declare const map: Record<string, unknown> | |||
There was a problem hiding this comment.
Do all these files have to be in the root dir?
Am a big fan of a clean root dir.
MFarabi619
commented
Aug 4, 2024
| @@ -0,0 +1,29 @@ | |||
| import type { MDXComponents } from 'mdx/types' | |||
There was a problem hiding this comment.
These are MDX components. MDX is essentially markdown supercharged with JSX, allowing us to use React components in our docs.
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.
If you want to be swept off your feet, navigate to
localhost:8000/docs.This is my custom implementation of the Fumadocs framework. I haven't found any other implementation that contains the top navbar as implemented here. I've also fixed various bugs still lurking in the APIs.
Key features
Edit on GitHubbutton for quick and easy doc fix PRsLast Updatedinfo in footer