Merge branch 'dev' of https://github.com/tabler/tabler into dev

.changeset/twenty-radios-punch.md

@@ -0,0 +1,5 @@
+---
+"@tabler/core": patch
+---
+
+Improve README 

README.md

@@ -15,7 +15,7 @@ A premium and open source dashboard template with a responsive and high-quality
 
 ## Sponsors
 
-**If you want to support our project and help me grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or just [donate on PayPal](https://paypal.me/codecalm) :)**
+**If you want to support our project and help us grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or just [donate on PayPal](https://paypal.me/codecalm) :)**
 
 <p align="center">
 	<a href="https://github.com/sponsors/codecalm">
@@ -23,8 +23,24 @@ A premium and open source dashboard template with a responsive and high-quality
 	</a>
 </p>
 
+<p align="center">
+	<a href="https://github.com/sponsors/codecalm" target="_blank">
+			<img src="https://raw.githubusercontent.com/tabler/tabler/dev/preview/static/sponsor-banner-homepage.svg" alt="Sponsor Banner">
+	</a>
+</p>
+
 ## Testing
 
+<p align="center">Visual testing with:</p>
+
+<p align="center">
+	<a href="https://argos-ci.com/" target="_blank">
+		<picture>
+			<img src="https://github.com/user-attachments/assets/7d231a26-eff5-4fc5-8392-b2a679a7c572" alt="Argos-CI" height="164" />
+		</picture>
+	</a>
+</p>
+
 <p align="center">Browser testing via:</p>
 
 <p align="center">
@@ -32,7 +48,7 @@ A premium and open source dashboard template with a responsive and high-quality
 		<picture>
 			<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/14dd2a0a-bafe-436e-a6cb-29636278c781">
 			<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/d3dede5a-d702-47c3-bb66-4d887948ed83">
-			<img src="https://github.com/user-attachments/assets/d3dede5a-d702-47c3-bb66-4d887948ed83" alt="Tabler Icons preview" width="296">
+			<img src="https://github.com/user-attachments/assets/d3dede5a-d702-47c3-bb66-4d887948ed83" alt="labmdatest" width="296">
 		</picture>
 	</a>
 </p>
@@ -56,147 +72,121 @@ We've created this admin panel for everyone who wants to create templates based
 * **HTML5 & CSS3:** We use only modern web technologies, such as HTML5 and CSS3. Our theme includes some subtle CSS3 animations, which will help you attract attention.
 * **Clean Code:** We followed Bootstrap’s guidelines carefully to make your integration as easy as possible. All code is handwritten and W3C valid.
 * **Demo pages**: Tabler features over 20 individual pages using various components, which gives you the freedom to choose and combine. All components can vary in color and styling that you can easily modify using Sass. Sky is the limit!
-* **Single Page Application versions:** [Tabler React](https://github.com/tabler/tabler-react) has React components for Tabler.
 
 ## 📖 Documentation
 
-Documentation is available as a part of Tabler preview: https://tabler.io/docs/
-
-To run the documentation site locally, follow instructions in the [Documentation README](https://github.com/tabler/tabler/blob/dev/site/README.md).
+The documentation is available at https://tabler.io/docs/
 
 ## 🪴 Project Activity
 
-![Alt](https://repobeats.axiom.co/api/embed/61d1db34446967b0848af68198a392067e0f5870.svg "Repobeats analytics image")
-
-## 💕 Sponsor Tabler
-
 <p align="center">
-	<a href="https://github.com/sponsors/codecalm" target="_blank">
-			<img src="https://raw.githubusercontent.com/tabler/tabler/dev/preview/static/sponsor-banner-homepage.svg" alt="Sponsor Banner">
-	</a>
+	<img src="https://repobeats.axiom.co/api/embed/61d1db34446967b0848af68198a392067e0f5870.svg" alt="Repobeats analytics image" />
 </p>
 
-### Sponsors
+## Installation
 
-Support this project by becoming a sponsor. Your logo will show up in this README with a link to your website. [Become a sponsor!](https://opencollective.com/tabler#sponsor)
+### Package Managers
 
-<a href="https://opencollective.com/tabler/tiers/sponsor/0/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/0/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/1/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/1/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/2/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/2/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/3/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/3/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/4/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/4/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/5/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/5/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/6/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/6/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/7/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/7/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/8/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/8/avatar.svg" /></a>
-<a href="https://opencollective.com/tabler/tiers/sponsor/9/website" target="_blank"><img src="https://opencollective.com/tabler/tiers/sponsor/9/avatar.svg" /></a>
+Tabler is distributed via npm. You can install it with this or your preferred JavaScript package manager:
 
-## 📦 Setup environment
+```sh
+npm install --save @tabler/core
+```
 
-To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow the steps below:
+### CDN support
 
-1. [Install Node.js](https://nodejs.org/download/), which we use to manage our dependencies.
-2. Navigate to the root `/tabler` directory and run `pnpm install` to install our local dependencies listed in `package.json`.
+All files included in `@tabler/core` npm package are also available over a CDN.
 
-**OSX users**:
+#### Javascript
 
-```sh
-pnpm install
+```html
+<script src="https://cdn.jsdelivr.net/npm/@tabler/core@latest/dist/js/tabler.min.js"></script>
 ```
 
-and then 
+#### Styles
 
-```sh
-npm run start
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tabler/core@latest/dist/css/tabler.min.css">
 ```
 
-**Windows users**:
-
-[Install Git](https://git-scm.com/download/win) in `C:\Program Files\git\bin` directory and run `npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"` to change the default shell.
+## Building locally
 
-Once you complete the setup, you'll be able to run the various commands provided from the command line.
+To build a copy of Tabler locally, you have two options. You can either set up your device directly with the development tools required to build Tabler, or if you would prefer not to install all the development dependencies directly onto your device, you can use a Dockerfile that Tabler provides to build a docker image. Instructions follow below.
 
+### First steps: Downloading the Tabler source files
 
-## Build locally
+With either method, the first thing you'll want to do is download a copy of the Tabler source files to your device.
 
-You need to have `pnpm` installed.
+#### From the Tabler GitHub releases page
 
-1. From the root `/tabler` directory, run installation in the command line: `pnpm install` 
-2. Then execute `pnpm run start` to start up the application stack.
-3. Open [http://localhost:3000](http://localhost:3000) in your browser, and voilà.
-4. Any change in the `/src` directory will build the application and refresh the page.
+If you don't want to edit the source code once you've downloaded it, and aren't interested in merging future project updates into your copy, you can just download the source files straight from the [Tabler releases on GitHub](https://github.com/tabler/tabler/releases) and extract the contents to a directory called `tabler`.
 
-**Note**:
-Run `pnpm run build` for reforms a one off build application without refresh.
-Open [http://localhost:3001](http://localhost:3001) to configure the Web server.
+#### Cloning with Git
 
-## Installation
+If you **do** wish to edit the source code after downloading it, for example to contribute changes back to the Tabler project, you'll want to do this by cloning it with Git:
+1. If you don't have Git installed on your device, download and install it. You can find instructions at [https://git-scm.com/downloads](https://git-scm.com/downloads).
+2. (Optional) **Windows users:** you could optionally install Git in the `C:\Program Files\git\bin` directory and run `npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"` to change the default shell.
+3. Clone the Tabler project into a folder on your device. Instructions can be found at [cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
 
-Tabler is distributed via npm.
+### Installing and running development tools directly
 
+1. [Install Node.js](https://nodejs.org/download/), which we use to manage our dependencies.
+2. [Install pnpm](https://pnpm.io/installation) (We recommend either by [Using Corepack](https://pnpm.io/installation#using-corepack) or by [Using npm](https://pnpm.io/installation#using-npm))
+3. From the root `/tabler` directory where you downloaded the Tabler source files, run installation on the command line:
 ```sh
-npm install --save @tabler/core
+pnpm install
 ```
-
-## Running with Docker
-
-**Plain Docker**
-
-If you don't want to install node/npm and the dependencies on your local environment, you can use the provided Dockerfile to build a docker image.
-This Dockerfile is provided as an example to spin-up a container running Tabler.
-
-Example of how to use this image:
-
-1. Build the tabler image : `docker build -t tabler .`
-2. Run the tabler image while mounting the `src` directory as well as the `_config.yml` file into the container.
-
-Don't forget to expose the port 3000 so you can browse the website locally.
-You can also expose the port 3001 to have access to BrowserSync
-
+4. Then execute the following to start up the application stack:
 ```sh
-docker run -p 3000:3000 -p 3001:3001 -v $(pwd)/src:/app/src -v $(pwd)/_config.yml:/app/_config.yml tabler
+pnpm run start
 ```
+5. Open [http://localhost:3000](http://localhost:3000) in your browser, and voilà.
+Any change in the `/src` directory will rebuild the application and refresh the page.
 
-Now open your browser to [http://localhost:3000](http://localhost:3000). Edit anything in the `src/` folder and watch your browser refresh the page after it has been rebuilt.
-
-**Docker Compose**
+**Note**:
+If you wish to perform a one-off build without auto-refresh on any changes, you can run:
+```sh
+pnpm run build
+```
+You can open [http://localhost:3001](http://localhost:3001) to configure the Web server.
 
-You can also use the docker compose config from this repo. Use `docker compose build && docker compose up` or `docker compose up --build` to build and start the container. Edit anything in the `src/` folder the same way as with plain docker and access the same URLs and ports in your browser.
 
-### CDN support
+### Installing and running development tools with Docker
 
-All files included in `@tabler/core` npm package are available over a CDN.
+**Plain Docker**
 
-#### Javascript
+Here is an example of how to use this image:
 
-```html
-<script src="https://cdn.jsdelivr.net/npm/@tabler/core@latest/dist/js/tabler.min.js"></script>
+1. From the root `/tabler` directory where you downloaded the Tabler source files, build the tabler image:
+```sh
+docker build -t tabler .
 ```
-
-#### Styles
-
-```html
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@tabler/core@latest/dist/css/tabler.min.css">
+2. Run the tabler image. The following command mounts the `src` directory into the container, exposes port 3000 to browse the website locally, and exposes port 3001 to automatically sync changes:
+```sh
+docker run -p 3000:3000 -p 3001:3001 -v $(pwd)/src:/app/src tabler
 ```
+3. Open your browser to [http://localhost:3000](http://localhost:3000). Edit anything in the `src/` folder and watch your browser refresh the page after it has been rebuilt.
 
-## Feature requests
-
-https://tabler.canny.io/feature-requests
+**Docker Compose**
 
+You can also use the docker compose config from this repo. From the root `/tabler` directory where you downloaded the Tabler source files, use `docker compose build && docker compose up` or `docker compose up --build` to build and start the container. Edit anything in the `src/` folder the same way as with plain docker and access the same URLs and ports in your browser.
 
 ## Bugs and feature requests
 
 Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new).
 
-
 ## 🤓 Creators
 
 **Paweł Kuna**
 
-- <https://twitter.com/codecalm>
+- <https://x.com/codecalm>
 - <https://github.com/codecalm>
 - <https://codecalm.net>
 
+**Bartłomiej Gawęda**
+
+- <https://x.com/B_Gaweda>
+- <https://github.com/BG-Software-BG>
 
 ## 👨‍🚀 Contributors
 
@@ -204,25 +194,11 @@ This project exists thanks to all the people who contribute.
 
 <img src="https://opencollective.com/tabler/contributors.svg?width=890&button=false" />
 
-## 🌸 Backers
+## Social media
 
-Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/tabler#backer)
-
-<a href="https://opencollective.com/tabler#backers" target="_blank"><img src="https://opencollective.com/tabler/tiers/backer.svg?width=890&button=false" /></a>
+Stay up to date by joining our community on <a href="https://x.com/tabler_io" >X</a> and <a href="https://www.facebook.com/tabler.io">Facebook</a>
 
 ## License
 
 See the [LICENSE](https://github.com/tabler/tabler/blob/master/LICENSE) file.
 
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

core/docs/emails/index.mdx

@@ -6,9 +6,3 @@ description: Customizable email templates for over 90 clients and devices.
 summary: Tabler Emails is a set of 80 eye-catching, customizable HTML templates. They are compatible with over 90 email clients and devices.
 seoDescription: Tabler Emails is a collection of 80 premium, customizable HTML templates. They are compatible with over 90 email clients and devices.
 ---
-
-# Tabler Emails
-
-*Change below image!*
-
-![Tabler Emails](/docs/cover-illustrations.png)