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: added documentation to code components #120

Merged
merged 3 commits into from
May 2, 2024
Merged

Conversation

epoll31
Copy link
Contributor

@epoll31 epoll31 commented May 2, 2024

Description

I added documentation to the code related components in src/components/code/.

Related Issue

Fixes #116

Proposed Changes

  • Added code documentation to
    • Code.tsx
    • CodeGroup.tsx
    • CodeGroupFromFile.tsx
    • ComponentPreview.tsx
    • PreviewCodeGroup.tsx

Checklist

Please check the boxes that apply:

  • I have tested the changes locally
  • I ran npm run build and build is successful
  • I have added necessary documentation (if applicable)
  • I have updated the credits.md file (if applicable)

Copy link

vercel bot commented May 2, 2024

@epoll31 is attempting to deploy a commit to the SyntaxUI Team on Vercel.

A member of the Team first needs to authorize it.

@Ansub
Copy link
Member

Ansub commented May 2, 2024

  • can you add path of one example usage of where these components are being used
  • instead of @props make it @params

@epoll31
Copy link
Contributor Author

epoll31 commented May 2, 2024

@Ansub changed @props to @params and added @example

Copy link

vercel bot commented May 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
syntax-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 2, 2024 4:20pm

@Ansub Ansub added the documentation Improvements or additions to documentation label May 2, 2024
@Ansub Ansub merged commit ef7a9f3 into SyntaxUI:main May 2, 2024
2 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs]: add code docs for listed components
2 participants