search

SyntaxUI / syntaxui

Get free access to pre-built, Tailwind CSS-powered components, animations and effects - brought to life using Framer Motion. Just copy, paste and you're ready to go!
https://syntaxui.com
MIT License
636 stars 45 forks source link

[docs]: add code docs for listed components #116

Closed Ansub closed 2 months ago

Ansub commented 2 months ago

Feature Description 📝

add documentation in code for these components:

./src/components/code
├── Code.tsx
├── CodeGroup.tsx
├── CodeGroupFromFile.tsx
├── ComponentPreview.tsx
└── PreviewCodeGroup.tsx

Can add something like this on top: 

/**
   * This function does this and this 
   *this a path or any param you wannna talk about
   * useful 
    * example of one component where this  component is being used
   */