-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1397 from Infineon/update-foundation-and-setup-do…
…cumentation Added tailwind css page
- Loading branch information
Showing
8 changed files
with
58 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
packages/components/src/stories/setup-and-installation/TailwindCSS.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import { Meta, Description } from '@storybook/blocks'; | ||
|
||
<Meta title="Setup & installation/Tailwind CSS" /> | ||
|
||
# Using Tailwind CSS with our Design System | ||
|
||
## What is Tailwind CSS? | ||
|
||
Tailwind CSS is a popular, highly customizable, and widely-used utility-first CSS framework that allows developers to write more concise and maintainable code. It provides a set of pre-defined classes to style HTML elements, making it easy to create consistent and responsive user interfaces. With Tailwind CSS, you can focus on building your application's layout and design without worrying about writing custom CSS code. | ||
|
||
## Why are we offering Tailwind CSS with our Design System? | ||
|
||
We understand the importance of consistency and efficiency in front-end development. By providing a custom Tailwind CSS config file tailored to our design system, we aim to simplify the development process and ensure that our design tokens are applied consistently across all applications. This integration enables developers to leverage the power of Tailwind CSS while maintaining the visual identity of our design system. | ||
|
||
## How to use Tailwind CSS with our Design System | ||
|
||
To get started with Tailwind CSS and our custom config file, follow these steps: | ||
|
||
### 1. Install Tailwind CSS | ||
|
||
Use the default Tailwind CSS instructions to install Tailwind CSS in your project. | ||
|
||
### 2. Download our custom config file | ||
|
||
Head over to our GitHub repository ([Link to GitHub repository](https://github.com/Infineon/infineon-design-system-tailwind-config/)) and download the custom Tailwind CSS config file. | ||
|
||
### 3. Add the config file to your project | ||
|
||
Update your project with our config file. | ||
|
||
### 4. Start using Tailwind CSS classes | ||
|
||
Begin using Tailwind CSS in your project. You can refer to the Tailwind CSS documentation for a comprehensive list of available classes and their usage and check the [demo page](https://infineon.github.io/infineon-design-system-tailwind-config/) for our custom styles. | ||
|
||
## Additional Resources | ||
|
||
For more detailed information on using Tailwind CSS with our design system, including configuration options and best practices, please visit our GitHub repository ([Link to GitHub repository](https://github.com/Infineon/infineon-design-system-tailwind-config/)). You can also find the custom config file available for download on the same page. | ||
|
||
<p align="right"><a href="#tableContent">back to top</a></p> |