Add documentation App (#2219)

This commit is contained in:
Paweł Kuna
2025-04-15 23:18:49 +02:00
committed by GitHub
parent 199f39a52e
commit 8d4f8d07c3
1550 changed files with 5414 additions and 5340 deletions
+15
View File
@@ -0,0 +1,15 @@
---
title: EPS version
description: Download Tabler Icons in EPS format.
---
![](/img/icons/package-eps.png)
## Installation
{% include "docs/tabs-package.html" name="@tabler/icons-eps" %}
or just [download from Github](https://github.com/tabler/tabler-icons/releases).
All EPS files are stored in `icons` subdirectory.
+5
View File
@@ -0,0 +1,5 @@
---
title: Static files
description: Download static file formats of icons.
summary: Static files provide multiple formats of Tabler Icons, including EPS, PDF, PNG, and SVG, offering flexibility for different design and development workflows.
---
+15
View File
@@ -0,0 +1,15 @@
---
title: PDF version
description: Download Tabler Icons in PDF format.
---
![](/img/icons/package-pdf.png)
## Installation
{% include "docs/tabs-package.html" name="@tabler/icons-pdf" %}
or just [download from Github](https://github.com/tabler/tabler-icons/releases).
All PDF files are stored in `icons` subdirectory.
+31
View File
@@ -0,0 +1,31 @@
---
title: PNG version
description: Download Tabler Icons in PNG format.
---
![](/img/icons/package-png.png)
## Installation
{% include "docs/tabs-package.html" name="@tabler/icons-png" %}
or just [download from Github](https://github.com/tabler/tabler-icons/releases).
All PNG files are stored in `icons` subdirectory.
## CDN
#### Outline version
```html
<img src="https://unpkg.com/@tabler/icons-png@$ICONS_VERSION/icons/outline/home.png" />
```
#### Filled version
```html
<img src="https://unpkg.com/@tabler/icons-png@$ICONS_VERSION/icons/filled/home.png" />
```
Instead of a specific version, you can use `latest` to always get the newest icons.
+72
View File
@@ -0,0 +1,72 @@
---
title: SVG version
description: Download Tabler Icons in SVG format.
---
![](/img/icons/package-svg.png)
## Installation
{% include "docs/tabs-package.html" name="@tabler/icons" %}
or just [download from Github](https://github.com/tabler/tabler-icons/releases).
## Usage
All icons are built with SVG, so you can place them as `<img>`, `background-image` and inline in HTML code.
### HTML image
If you load an icon as an image, you can modify its size using CSS.
```html
<img src="path/to/icon.svg" alt="icon title" />
```
### Inline HTML
You can paste the content of the icon file into your HTML code to display it on the page.
```html
<a href="">
{% include "ui/icon.html" icon="disabled" %}
Click me
</a>
```
Thanks to that, you can change the size, color and the `stroke-width` of the icons with CSS code.
```css
.icon-tabler {
color: red;
width: 32px;
height: 32px;
stroke-width: 1.25;
}
```
### SVG sprite
Add an icon to be displayed on your page with the following markup (`activity` in the above example can be replaced with any valid icon name):
```html
<svg width="24" height="24">
<use xlink:href="path/to/tabler-sprite.svg#tabler-activity" />
</svg>
```
## CDN
#### Outline version
```html
<img src="https://unpkg.com/@tabler/icons@$ICONS_VERSION/icons/outline/home.svg" />
```
#### Filled version
```html
<img src="https://unpkg.com/@tabler/icons@$ICONS_VERSION/icons/filled/home.svg" />
```
Instead of a specific version, you can use `latest` to always get the newest icons.