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: new integration guides #1194

Merged
merged 19 commits into from
Dec 19, 2023
Merged

docs: new integration guides #1194

merged 19 commits into from
Dec 19, 2023

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Dec 18, 2023

Summary

Integration guides for all current React related frameworks/technologies that flowbite-react can be installed into.

Changes

  • replace @mapbox/rehype-prism in favor of rehype-prism-plus for line highlighting features (see screenshots below)
  • create new "integration guides" section
  • create new integration guides for the following:
    • Next.js
    • Vite
    • Remix
    • Astro
    • Gatsby
    • Laravel
    • Parcel
    • Create React App
    • RedwoodJS
  • explicit dark mode support integration for the frameworks that do SSR
  • use Link from Next.js for internal routes

Result

New "Integration guides" section

Screenshot 2023-12-18 at 13 38 02

New code highlight line

Screenshot 2023-12-18 at 13 38 54

@SutuSebastian SutuSebastian added the 📚 documentation Improvements or additions to documentation label Dec 18, 2023
@SutuSebastian SutuSebastian self-assigned this Dec 18, 2023
Copy link

vercel bot commented Dec 18, 2023

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

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2023 2:11pm

@SutuSebastian SutuSebastian requested review from rluders and removed request for tulup-conner December 18, 2023 11:49
Copy link
Collaborator

@tulup-conner tulup-conner left a comment

Choose a reason for hiding this comment

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

I don't have time to check the Astro, CRA, Laravel, RedwoodJS instructions but your instructions for the rest, which I have used a few times myself, look great.

content/docs/guides/gatsby.mdx Outdated Show resolved Hide resolved
content/docs/guides/next-js.mdx Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@SutuSebastian
Copy link
Collaborator Author

I don't have time to check the Astro, CRA, Laravel, RedwoodJS instructions but your instructions for the rest, which I have used a few times myself, look great.

Every single guide was tested by hand, from scratch, so I think we're covered there :D

…to mix CJS and ESM modules bundle (known issue)
@SutuSebastian SutuSebastian merged commit f186ec8 into main Dec 19, 2023
3 checks passed
@SutuSebastian SutuSebastian deleted the docs/integration-guides branch December 19, 2023 18:36
ddiasfront pushed a commit to ddiasfront/flowbite-react that referenced this pull request Dec 29, 2023
* replace `@mapbox/rehype-prism` in favor of `rehype-prism-plus` for line highlighting features

* docs:
- add new "integration guides" section
- create new Next.js guide

* docs: create new Vite guide; fix `token.operator` bg color

* docs: Next.js guide - slight refactor

* fix: typo

* docs: create new Remix guide

* docs: create new Astro guide

* fix: astro typo

* docs: create new Gatsby guide

* docs: create new Laravel + Inertia guide

* docs: create new Parcel guide

* docs: create new Create React App guide

* docs: create new RedwoodJS guide

* move all docs packages to `devDependencies`

* bring back `contentlayer` to `dependencies` due to `yarn@V1` failing to mix CJS and ESM modules bundle (known issue)

* fix deprecated value in `settings.json` file

* remove redundant installation of `flowbite` in docs

* fix nextjs guide path

* mdx: use Next.js `Link` instead of `a` element + open in new tab for external links

---------

Co-authored-by: Sebastian Sutu <[email protected]>
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.

2 participants