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

feat: Documentation templates #8

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

ehoops-cz
Copy link
Contributor

This PR adds:

  • some custom MDX components
  • some example files that use the MDX components
  • a /faq route that displays example faq
  • documentation for how to update the documentation in the github ui
  • tailwind
    Note - should I replace the example file content with lorem ipsum?
Screenshot 2024-09-03 at 1 16 13 PM

"sds-caps-xxs": "18px",
"sds-caps-xxxs": "16px",
"sds-caps-xxxxs": "14px",
},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems odd to have our template override the sds defaults. However, the documentation looks cramped without this.

@ehoops-cz ehoops-cz requested a review from tihuan September 3, 2024 20:20
Copy link
Collaborator

@tihuan tihuan left a comment

Choose a reason for hiding this comment

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

Thanks so much again for the PR, @ehoops-cz !

I just realized that since the tailwind implementation touches the whole app setup, I wonder if we should turn this repo into a monorepo with two templates, one for CSS in JS and the other for Tailwind?

This way we don't end up with a template that has both CSS in JS and Tailwind 😄

If that sounds good to you, maybe let's keep this PR as a draft for now, and I'll do some research to reorganize the repo accordingly and we can refactor this PR to work with the new repo structure 🙏

Thanks so much again for the template! Look forward to adding it to the repo 🎉 !!

"react-dom": "^18",
"tailwind-merge": "^2.5.2",
"tailwindcss": "^3.4.10",
"webpack": "^5.94.0"
Copy link
Collaborator

Choose a reason for hiding this comment

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

just curious, which packages require us to use webpack directly? I was hoping to keep it behind the scene and managed by Next.js 😆

source: https://nextjs.org/docs/app/api-reference/next-config-js/webpack

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tihuan It's a peer dependency of @mdx-js/loader 😭

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mdx-js/loader is part of the nextjs recommended mdx setup: https://nextjs.org/docs/pages/building-your-application/configuring/mdx

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ooh I see! Thanks for the doc 💡 😄

Hmm maybe we still don't need to have webpack as direct dependency like Vercel's example here?

https://github.com/vercel/next.js/blob/canary/examples/with-mdx/package.json

@ehoops-cz ehoops-cz marked this pull request as draft September 4, 2024 16:50
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