Steps to add a new Component. - #1
Merged
Merged
Conversation
added 5 commits
September 8, 2025 05:43
num-js
added
add-new-component
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
1 participant
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.
🛠️ How to Add a New Component
Follow these steps to add a new component: View Full PR
Create the Component
Add your component inside
registry/components. For example:registry/components/card-hover/card-hover.tsx.View Changes
Document the Component
Create an MDX file inside
content/componentsto provide detailed documentation with previews and code examples.Example:
content/components/card-hover.mdx.View Changes
Update Documentation Config
Add the component's documentation metadata in
configs/componentsDocumentation.json.View Changes
Update Sidebar Metadata
Add the component's name and path in
configs/leftSideComponentMetaData.tsto display it in the sidebar.View Changes
(Optional) Add Component Overview
Add metadata and a thumbnail for the component in
configs/componentsOverview.tsto display it in the Components tab (/components).View Changes