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

Docs #110

Open
2 of 5 tasks
nachoaldamav opened this issue Aug 21, 2022 · 0 comments
Open
2 of 5 tasks

Docs #110

nachoaldamav opened this issue Aug 21, 2022 · 0 comments

Comments

@nachoaldamav
Copy link
Collaborator

nachoaldamav commented Aug 21, 2022

How to make a doc:

  1. Create MDX file in /app/docs
  2. Start adding meta information, check another file for reference
  3. The first line should be the module import
  4. Add examples
  5. To import examples, create a component in /app/src/demo/{component}
  6. Add that component to /app/component/mdx/index.tsx
  7. Use the Element in the MDX file, you can find references in another files.
@nachoaldamav nachoaldamav pinned this issue Aug 21, 2022
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

No branches or pull requests

1 participant