Skip to content

docs: add react component docs #117

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

Merged
merged 14 commits into from
Jul 11, 2024
Merged

docs: add react component docs #117

merged 14 commits into from
Jul 11, 2024

Conversation

Nemikolh
Copy link
Member

@Nemikolh Nemikolh commented Jul 4, 2024

This PR adds docs for TutorialKit React components.

While writing those docs I noticed several improvements we could make:

  • Right now, you have to configure unocss in order to get a style with all the required classes. After discussing this issue with @d3lm, we thought we could generate a CSS file that would be shipped as part of the @tutorialkit/components-react.
  • Customizability
    • Choose the icon for the open / closed folder and for the files in the FileTree (maybe even per file type?)
    • Easily tweak settings of the CodeMirrorEditor: dark / light theme, code mirror extensions

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

cloudflare-workers-and-pages bot commented Jul 9, 2024

Deploying tutorialkit-docs-page with  Cloudflare Pages  Cloudflare Pages

Latest commit: da5da7d
Status: ✅  Deploy successful!
Preview URL: https://753acf83.tutorialkit-docs-page.pages.dev
Branch Preview URL: https://joan-react-comp-docs.tutorialkit-docs-page.pages.dev

View logs

Copy link

cloudflare-workers-and-pages bot commented Jul 9, 2024

Deploying tutorialkit-demo-page with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2a1be0c
Status: ✅  Deploy successful!
Preview URL: https://6247949a.tutorialkit-demo-page.pages.dev
Branch Preview URL: https://joan-react-comp-docs.tutorialkit-demo-page.pages.dev

View logs

@Nemikolh Nemikolh marked this pull request as ready for review July 9, 2024 18:05
@Nemikolh Nemikolh requested review from SamVerschueren and d3lm July 10, 2024 08:39
@Nemikolh Nemikolh requested a review from AriPerkkio July 10, 2024 12:19
@AriPerkkio
Copy link
Member

There's some weird white box caused by scroll overflows - do you see this too?

@Nemikolh
Copy link
Member Author

@AriPerkkio Oh good catch! I had a similar issue with the code blocks. I'll move the hack there too. It's only a chrome issue 😞

Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks really good! I like seeing the actual components on the documentation page. 🎉

@Nemikolh Nemikolh requested a review from AriPerkkio July 10, 2024 17:52
@Nemikolh Nemikolh merged commit ef50b2b into main Jul 11, 2024
9 checks passed
@Nemikolh Nemikolh deleted the joan/react-comp-docs branch July 11, 2024 08:14
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

Successfully merging this pull request may close these issues.

2 participants