Skip to content
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

Add an components page explaining all custom components #11

Open
nisabmohd opened this issue Sep 8, 2024 · 2 comments
Open

Add an components page explaining all custom components #11

nisabmohd opened this issue Sep 8, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@nisabmohd
Copy link
Owner

nisabmohd commented Sep 8, 2024

I would like a single page that contains all the markdown elements, including standard markdown files such as headings, lists, blockquotes, code blocks (with showLineNumbers and line highlighting), and the tab component I'm using to switch code. It should also cover how to add images, links, the note component, and the stepper. This will help make everything clear for anyone who is going to use this, so only the necessary markdown custom components and standard markdown elements should be included. Documenting all components used in the project won't be useful.

I also want to modify the "Get Started" page to include instructions on where the content should be placed, specifying that content files should be in the .mdx extension with the appropriate frontmatter. Additionally, please include details on how to configure routes, how to clone the GitHub repository, install dependencies using npm i, and add information about other versions in the "Get Started" section.

@nisabmohd nisabmohd added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Sep 8, 2024
@shabaz39
Copy link

shabaz39 commented Sep 9, 2024

I have made a PR. Kindly review it and let me know if there are any changes to be made.

@nisabmohd
Copy link
Owner Author

Please check comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants