mirror of
https://github.com/gromlab-ru/svg-sprites.git
synced 2026-07-22 04:40:17 +03:00
feat: добавить серверную генерацию спрайтов
This commit is contained in:
@@ -30,13 +30,19 @@
|
||||
|
||||
Пути, имена, команды, импорты и названия сгенерированных API должны соответствовать друг другу и фактическому результату генерации.
|
||||
|
||||
Во всех гайдах используются согласованные примеры:
|
||||
Во всех consumer-гайдах используются согласованные примеры:
|
||||
|
||||
- исходные SVG находятся в `assets/svg-icons`;
|
||||
- спрайт создаётся в `assets/app-icons`;
|
||||
- конфиг записывается в JSON;
|
||||
- имя спрайта в конфиге — `app`.
|
||||
|
||||
`standalone@server` является исключением: quick start использует config-less CLI,
|
||||
исходные SVG находятся в `./icons` временного worker workspace, output создаётся в
|
||||
текущем каталоге, а mode, name и input передаются флагами одной команды. Server
|
||||
config упоминается только как дополнительный вариант; подключение из consumer
|
||||
может использовать обычный JSON config соответствующего mode.
|
||||
|
||||
## Зависимости
|
||||
|
||||
В разделе генерации нужно явно показать ключевое преимущество: для создания и использования спрайта пакет не требуется добавлять в зависимости проекта.
|
||||
@@ -48,7 +54,7 @@ Viewer описывается отдельно как необязательны
|
||||
Гайд должен содержать только минимальный рабочий путь:
|
||||
|
||||
- структуру проекта;
|
||||
- конфиг;
|
||||
- конфиг либо полный config-less CLI-вызов для `standalone@server`;
|
||||
- команду генерации;
|
||||
- автоматическую генерацию перед запуском и сборкой, если она необходима;
|
||||
- подключение иконки;
|
||||
|
||||
Reference in New Issue
Block a user