diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a17273b3e..079516de7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -26,25 +26,6 @@ jobs: collaborators: 'outside' env: GITHUB_TOKEN: ${{ secrets.SA_TOKEN }} - maintainers: - runs-on: ubuntu-latest - name: Maintainers - steps: - - name: Doc maintainers - uses: akhilmhdh/contributors-readme-action@v2.3.6 - if: github.event_name == 'push' - with: - image_size: 50 - readme_path: 'documentation/contributing/Maintainers.md' - columns_per_row: 8 - use_username: true - commit_message: 'docs(chore): update maintainers' - committer_username: 'spark-ui-bot' - committer_email: 'gp.gt.ft.ade.spark@adevinta.com' - auto_detect_branch_protection: false - collaborators: 'outside' - env: - GITHUB_TOKEN: ${{ secrets.SA_TOKEN }} release: runs-on: ubuntu-latest steps: diff --git a/documentation/contributing/Contributors.md b/documentation/contributing/Contributors.md index b934b5f2a..7121c0464 100644 --- a/documentation/contributing/Contributors.md +++ b/documentation/contributing/Contributors.md @@ -1,6 +1,85 @@ # Contributors - + + + + + + + + + + + + + +
+ + andresin87 +
+ andresin87 + + 		+ + Powerplex +
+ Powerplex + + 		+ + acd02 +
+ acd02 + + 		+ + andresz1 +
+ andresz1 + + 		+ + soykje +
+ soykje + + 		+ + kikoruiz +
+ kikoruiz + + 		+ + solygambas +
+ solygambas + + 		+ + arnau-rius +
+ arnau-rius + +
+ + danieleloscozzese +
+ danieleloscozzese + + 		+ + tomasmax +
+ tomasmax + + 		+ + ferminhg +
+ ferminhg + +
- + diff --git a/documentation/contributing/Contributors.mdx b/documentation/contributing/Contributors.mdx deleted file mode 100644 index 9822cf202..000000000 --- a/documentation/contributing/Contributors.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import { Meta, Markdown } from '@storybook/blocks' -import Contributors from './Contributors.md?raw' - - - -{Contributors} diff --git a/documentation/contributing/Maintainers.md b/documentation/contributing/Maintainers.md index 683ebc67d..2882ed639 100644 --- a/documentation/contributing/Maintainers.md +++ b/documentation/contributing/Maintainers.md @@ -1,15 +1,7 @@ # Maintainers - - - - - - - - - - +
- - andresin87 -
- andresin87 - - 		Powerplex @@ -24,13 +16,6 @@ acd02 - - andresz1 -
- andresz1 - - 		soykje @@ -38,48 +23,5 @@ soykje - - kikoruiz -
- kikoruiz - - 		- - solygambas -
- solygambas - - 		- - arnau-rius -
- arnau-rius - -
- - danieleloscozzese -
- danieleloscozzese - - 		- - tomasmax -
- tomasmax - - 		- - ferminhg -
- ferminhg - -
- diff --git a/documentation/contributing/Maintainers.mdx b/documentation/contributing/Maintainers.mdx deleted file mode 100644 index c669a2fac..000000000 --- a/documentation/contributing/Maintainers.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import { Meta, Markdown } from '@storybook/blocks' -import Maintainers from './Maintainers.md?raw' - - - -{Maintainers} diff --git a/documentation/using-spark/Setup.mdx b/documentation/using-spark/Setup.mdx index 38be26273..5ae897c96 100644 --- a/documentation/using-spark/Setup.mdx +++ b/documentation/using-spark/Setup.mdx @@ -6,25 +6,21 @@ import { Callout } from '@docs/helpers/Callout' # Setup -## 1. Setup TailwindCSS +## Prerequisites -If you haven't installed **TailwindCSS** on your project yet, you **must** follow the [TailwindCSS installation guide](https://tailwindcss.com/docs/installation). +**Spark UI** being based on **Tailwind CSS** library, you will need to [have it installed](https://tailwindcss.com/docs/installation) in your system. -## 2. IntelliSense +To take benefit of a full empowered developper experience (autocomplete, syntax highlighting, linting...), you should also take a look at [**Tailwind CSS IntelliSense**](https://tailwindcss.com/docs/editor-setup#intelli-sense-for-vs-code) extension. For now it comes actually only for VS Code but you also may be interested on equivalent solutions such as the ones provided [for JetBrains IDEs](https://www.jetbrains.com/help/webstorm/tailwind-css.html). -The official Tailwind CSS [IntelliSense extension](https://tailwindcss.com/docs/editor-setup#intelli-sense-for-vs-code) for **Visual Studio Code** enhances the Tailwind development experience by providing users with advanced features such as autocomplete, syntax highlighting, and linting. +## Spark setup -**JetBrains IDEs** like WebStorm, PhpStorm, and others include [support](https://www.jetbrains.com/help/webstorm/tailwind-css.html) for intelligent Tailwind CSS completions in your HTML and when using @apply. - -## 3. Setup Spark - -After setting up **Tailwind** for your application, install the following packages via your command line: +After completing the Tailwind CSS setup, you'll simply have to install the following packages via your command line: ```bash npm i @spark-ui/tailwind-plugins @spark-ui/theme-utils ``` -Next, navigate to your **Tailwind config file**. Refer to the example below for proper configuration of our **Spark plugins**: +Navigate to your `tailwind.config.js` file and refer to the example below for proper configuration of our **Spark plugins**: ```js // tailwind.config.js @@ -51,9 +47,9 @@ Two important notes regarding the example above: - we are using our default themes from our `theme-utils` package. However, you can replace it with your own themes, as long as they adhere to our `Theme` interface. The Theme interface is available through the [**@spark-ui/theme-utils**](?path=/docs/utils-theme--docs) package. -- The `sparkConfig` plugin accepts an object with two fields: `themes` and `htmlFontSize`. +- the `sparkConfig` plugin accepts an object with two fields: -**themes**: +**`themes`:** An object containing your themes. Each key in the object will be extracted to a `[data-theme]` attribute, and the values will be converted to CSS custom properties inside the `css` file generated by Tailwing. **Note that this object requires a key with a value of default**, which specifies the default theme for your project. @@ -81,7 +77,7 @@ Tailwind will generate the following CSS: } ``` -**htmlFontSize (optional)**: +**`htmlFontSize` (optional):** Spark uses a base font size of **16 pixels** as a standard value for calculating the sizes of all other font-related properties defined in the theme. For example, our `spacing.lg` value is defined as **1rem**, which is equal to 16 pixels (based on the default base font size of 16 pixels). @@ -113,15 +109,13 @@ module.exports = { } ``` -That's all there is to it! 🎉 - If you want to know more about the custom token class names used in Spark, please check out our [**dedicated page**](https://sparkui.vercel.app/viewer/) where you can find a comprehensive list of these class names. -
+