docs: обновить README — прямая ссылка на превью, комментарии в конфиге
This commit is contained in:
16
README.md
16
README.md
@@ -1,9 +1,9 @@
|
|||||||
# @gromlab/svg-sprites
|
# @gromlab/svg-sprites
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
Генерация SVG-спрайтов из папок с иконками. TypeScript-типизация, SVG-трансформации, React-компонент и HTML-превью из коробки.
|
Генерация SVG-спрайтов из папок с иконками. TypeScript-типизация, SVG-трансформации, React-компонент и HTML-превью из коробки.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
## Установка
|
## Установка
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -18,10 +18,16 @@ npm install @gromlab/svg-sprites
|
|||||||
import { defineConfig } from '@gromlab/svg-sprites'
|
import { defineConfig } from '@gromlab/svg-sprites'
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
output: 'public',
|
// Папка для сгенерированных SVG-спрайтов
|
||||||
publicPath: '/public',
|
output: 'public/sprites',
|
||||||
|
|
||||||
|
// URL-путь к спрайтам (для href в React-компоненте)
|
||||||
|
publicPath: '/public/sprites',
|
||||||
|
|
||||||
|
// Папка для React-компонента и типов
|
||||||
react: 'src/shared/ui/svg-sprite',
|
react: 'src/shared/ui/svg-sprite',
|
||||||
|
|
||||||
|
// Массив спрайтов имя и откуда наполняем.
|
||||||
sprites: [
|
sprites: [
|
||||||
{ name: 'icons', input: 'src/assets/icons' },
|
{ name: 'icons', input: 'src/assets/icons' },
|
||||||
{ name: 'logos', input: 'src/assets/logos' },
|
{ name: 'logos', input: 'src/assets/logos' },
|
||||||
|
|||||||
Reference in New Issue
Block a user