You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

205 lines
16 KiB

4 years ago
  1. [english](https://github.com/svg/svgo/blob/master/README.md) | **русский**
  2. - - -
  3. <img src="https://svg.github.io/svgo-logo.svg" width="200" height="200" alt="logo"/>
  4. ## SVGO [![NPM version](https://badge.fury.io/js/svgo.svg)](https://npmjs.org/package/svgo) [![Build Status](https://secure.travis-ci.org/svg/svgo.svg)](https://travis-ci.org/svg/svgo) [![Coverage Status](https://img.shields.io/coveralls/svg/svgo.svg)](https://coveralls.io/r/svg/svgo?branch=master)
  5. **SVG** **O**ptimizer – это инструмент для оптимизации векторной графики в формате SVG, написанный на Node.js.
  6. ![](https://mc.yandex.ru/watch/18431326)
  7. ## Зачем?
  8. SVG-файлы, особенно экспортированные из редакторов, содержат много избыточной и бесполезной информации, комментариев, скрытых элементов, неоптимальные или стандартные значения и другой мусор, удаление которого безопасно и не влияет на конечный вид изображения.
  9. ## Возможности
  10. SVGO имеет расширяемую архитектуру, в которой почти каждая оптимизация является отдельным расширением.
  11. Что у нас есть:
  12. | Plugin | Description | Default |
  13. | ------ | ----------- | ------- |
  14. | [cleanupAttrs](https://github.com/svg/svgo/blob/master/plugins/cleanupAttrs.js) | удаление переносов строк и лишних пробелов | `включен` |
  15. | [inlineStyles](https://github.com/svg/svgo/blob/master/plugins/inlineStyles.js) | перенос стилей из элементов `<style>` в атрибуты `style` | `включен` |
  16. | [removeDoctype](https://github.com/svg/svgo/blob/master/plugins/removeDoctype.js) | удаление doctype | `включен` |
  17. | [removeXMLProcInst](https://github.com/svg/svgo/blob/master/plugins/removeXMLProcInst.js) | удаление XML-инструкций | `включен` |
  18. | [removeComments](https://github.com/svg/svgo/blob/master/plugins/removeComments.js) | удаление комментариев | `включен` |
  19. | [removeMetadata](https://github.com/svg/svgo/blob/master/plugins/removeMetadata.js) | удаление `<metadata>` | `включен` |
  20. | [removeTitle](https://github.com/svg/svgo/blob/master/plugins/removeTitle.js) | удаление `<title>` | `включен` |
  21. | [removeDesc](https://github.com/svg/svgo/blob/master/plugins/removeDesc.js) | удаление `<desc>` | `включен` |
  22. | [removeUselessDefs](https://github.com/svg/svgo/blob/master/plugins/removeUselessDefs.js) | удаление элементов в `<defs>` без `id` | `включен` |
  23. | [removeXMLNS](https://github.com/svg/svgo/blob/master/plugins/removeXMLNS.js) | удаление атрибута xmlns (для заинлайненных svg) | `выключено` |
  24. | [removeEditorsNSData](https://github.com/svg/svgo/blob/master/plugins/removeEditorsNSData.js) | удаление пространств имён различных редакторов, их элементов и атрибутов | `включен` |
  25. | [removeEmptyAttrs](https://github.com/svg/svgo/blob/master/plugins/removeEmptyAttrs.js) | удаление пустых атрибутов | `включен` |
  26. | [removeHiddenElems](https://github.com/svg/svgo/blob/master/plugins/removeHiddenElems.js) | удаление скрытых элементов | `включен` |
  27. | [removeEmptyText](https://github.com/svg/svgo/blob/master/plugins/removeEmptyText.js) | удаление пустых текстовых элементов | `включен` |
  28. | [removeEmptyContainers](https://github.com/svg/svgo/blob/master/plugins/removeEmptyContainers.js) | удаление пустых элементов-контейнеров | `включен` |
  29. | [removeViewBox](https://github.com/svg/svgo/blob/master/plugins/removeViewBox.js) | удаление атрибута `viewBox`, когда это возможно | `включен` |
  30. | [cleanupEnableBackground](https://github.com/svg/svgo/blob/master/plugins/cleanupEnableBackground.js) | удаление или оптимизация атрибута `enable-background`, когда это возможно | `включен` |
  31. | [minifyStyles](https://github.com/svg/svgo/blob/master/plugins/minifyStyles.js) | уменьшает содержимое элементов `<style>` с помощью [CSSO](https://github.com/css/csso). | `включен` |
  32. | [convertStyleToAttrs](https://github.com/svg/svgo/blob/master/plugins/convertStyleToAttrs.js) | конвертирование стилей в атрибуте `style` в отдельные svg-атрибуты | `включен` |
  33. | [convertColors](https://github.com/svg/svgo/blob/master/plugins/convertColors.js) | конвертирование цветовых значений: из `rgb()` в `#rrggbb`, из `#rrggbb` в `#rgb` | `включен` |
  34. | [convertPathData](https://github.com/svg/svgo/blob/master/plugins/convertPathData.js) | конвертирование данных Path в относительные или абсолютные координаты, смотря что \|короче; конвертирование одних типов сегментов в другие; удаление ненужных разделителей; умное округление и тому подобное | `включен` |
  35. | [convertTransform](https://github.com/svg/svgo/blob/master/plugins/convertTransform.js) | схлопывание нескольких трансформаций в одну, конвертирование матриц в короткие алиасы \|и многое другое | `включен` |
  36. | [removeUnknownsAndDefaults](https://github.com/svg/svgo/blob/master/plugins/removeUnknownsAndDefaults.js) | удаление неизвестных элементов, контента и атрибутов | `включен` |
  37. | [removeNonInheritableGroupAttrs](https://github.com/svg/svgo/blob/master/plugins/removeNonInheritableGroupAttrs.js) | удаление ненаследуемых "презентационных" атрибутов групп | `включен` |
  38. | [removeUselessStrokeAndFill](https://github.com/svg/svgo/blob/master/plugins/removeUselessStrokeAndFill.js) | удаление неиспользуемых атрибутов stroke-* и fill-* | `включен` |
  39. | [removeUnusedNS](https://github.com/svg/svgo/blob/master/plugins/removeUnusedNS.js) | удаление деклараций неиспользуемых пространств имён | `включен` |
  40. | [prefixIds](https://github.com/svg/svgo/blob/master/plugins/prefixIds.js) | добавляет префикс в ID или классы в виде имени файла или произвольной строки | `выключено` |
  41. | [cleanupIDs](https://github.com/svg/svgo/blob/master/plugins/cleanupIDs.js) | удаление неиспользуемых и сокращение используемых ID | `включен` |
  42. | [cleanupNumericValues](https://github.com/svg/svgo/blob/master/plugins/cleanupNumericValues.js) | округление дробных чисел до заданной точности, удаление `px` как единицы \|измерения по-умолчанию | `включен` |
  43. | [cleanupListOfValues](https://github.com/svg/svgo/blob/master/plugins/cleanupListOfValues.js) | округление числовых значений в атрибутах со списком чисел, таких как `viewBox` \|или `enableBackground` | `выключено` |
  44. | [moveElemsAttrsToGroup](https://github.com/svg/svgo/blob/master/plugins/moveElemsAttrsToGroup.js) | перемещение совпадающих атрибутов у всех элементов внутри группы `<g>` | `включен` |
  45. | [moveGroupAttrsToElems](https://github.com/svg/svgo/blob/master/plugins/moveGroupAttrsToElems.js) | перемещение некоторых атрибутов группы на элементы внутри | `включен` |
  46. | [collapseGroups](https://github.com/svg/svgo/blob/master/plugins/collapseGroups.js) | схлопывание бесполезных групп `<g>` | `включен` |
  47. | [removeRasterImages](https://github.com/svg/svgo/blob/master/plugins/removeRasterImages.js) | удаление растровых изображений | `выключено` |
  48. | [mergePaths](https://github.com/svg/svgo/blob/master/plugins/mergePaths.js) | склеивание нескольких Path в одну кривую | `включен` |
  49. | [convertShapeToPath](https://github.com/svg/svgo/blob/master/plugins/convertShapeToPath.js) | конвертирование простых форм в Path | `включен` |
  50. | [convertEllipseToCircle](https://github.com/svg/svgo/blob/master/plugins/convertEllipseToCircle.js) | конвертирование вырожденного эллипса `<ellipse>` в круг `<circle>` | `включен` |
  51. | [sortAttrs](https://github.com/svg/svgo/blob/master/plugins/sortAttrs.js) | сортировка атрибутов элементов для удобочитаемости | `выключено` |
  52. | [sortDefsChildren](https://github.com/svg/svgo/blob/master/plugins/sortDefsChildren.js) | сортировка детей `<defs>` для лучшей компрессии | `включен` |
  53. | [removeDimensions](https://github.com/svg/svgo/blob/master/plugins/removeDimensions.js) | удаляет атрибуты width/height при наличии viewBox (противоречит removeViewBox — плагин должен быть выключен) | `выключено` |
  54. | [removeAttrs](https://github.com/svg/svgo/blob/master/plugins/removeAttrs.js) | удаляет атрибуты по указанному паттерну | `выключено` |
  55. | [removeAttributesBySelector](https://github.com/svg/svgo/blob/master/plugins/removeAttributesBySelector.js) | удаляет атрибуты по CSS-селектору | `выключено` |
  56. | [removeElementsByAttr](https://github.com/svg/svgo/blob/master/plugins/removeElementsByAttr.js) | удаляет элементы по указанным ID или классам | `выключено` |
  57. | [addClassesToSVGElement](https://github.com/svg/svgo/blob/master/plugins/addClassesToSVGElement.js) | добавляет имена классов корневому элементу `<svg>` | `выключено` |
  58. | [addAttributesToSVGElement](https://github.com/svg/svgo/blob/master/plugins/addAttributesToSVGElement.js) | добавляет атрибуты корневому элементу `<svg>` | `выключено` |
  59. | [removeOffCanvasPaths](https://github.com/svg/svgo/blob/master/plugins/removeOffCanvasPaths.js) | удаляет элементы вне отрисовываемой области | `выключено` |
  60. | [removeStyleElement](https://github.com/svg/svgo/blob/master/plugins/removeStyleElement.js) | удаляет элементы `<style>` | `выключено` |
  61. | [removeScriptElement](https://github.com/svg/svgo/blob/master/plugins/removeScriptElement.js) | удаляет элементы `<script>` | `выключено` |
  62. | [reusePaths](https://github.com/svg/svgo/blob/master/plugins/reusePaths.js) | Заменяет дублирующиеся элементы <path> ссылками <use> | `выключено` |
  63. Хотите узнать принципы работы и как написать свой плагин? [Конечно же, да!](https://github.com/svg/svgo/blob/master/docs/how-it-works/ru.md)
  64. ## Как использовать
  65. ```sh
  66. $ [sudo] npm install -g svgo
  67. ```
  68. ## Выполнение:
  69. ### Командная строка
  70. ```
  71. Запуск:
  72. svgo [OPTIONS] [ARGS]
  73. Параметры:
  74. -h, --help : Помощь
  75. -v, --version : Версия программы
  76. -i INPUT, --input=INPUT : Входной файл, "-" для STDIN
  77. -s STRING, --string=STRING : Входная строка SVG
  78. -f FOLDER, --folder=FOLDER : Входная папка, оптимизирует и перезаписывает все файлы *.svg
  79. -o OUTPUT, --output=OUTPUT : Выходной файл или папка (совпадает с входным по умолчанию), "-" для STDOUT
  80. -p PRECISION, --precision=PRECISION : Число цифр после запятой, переопределяет параметры плагинов
  81. --config=CONFIG : Файл конфигурации (или строка JSON) для расширения и замены настроек
  82. --disable=PLUGIN : Выключение плагина по имени, "--disable=PLUGIN1,PLUGIN2" для отключения нескольких плагинов
  83. --enable=PLUGIN : Включение плагина по имени, "--enable=PLUGIN3,PLUGIN4" для отключения нескольких плагинов
  84. --datauri=DATAURI : Результат в виде строки Data URI (base64, URI encoded или unencoded)
  85. --multipass : Оптимизация в несколько проходов для применения всех возможных оптимизаций
  86. --pretty : Удобочитаемое форматирование SVG
  87. --indent=INDENT : Размер отступа для удобочитаемого форматирования
  88. -r, --recursive : Совместно с '-f'. Рекурсивно обрабатывать *.svg файлы в папках.
  89. -q, --quiet : Подавляет вывод информации, выводятся только сообщения об ошибках
  90. --show-plugins : Доступные плагины
  91. Аргументы:
  92. INPUT : Аналогично --input
  93. ```
  94. * с файлами:
  95. ```sh
  96. $ svgo test.svg
  97. ```
  98. или:
  99. ```sh
  100. $ svgo *.svg
  101. ```
  102. ```sh
  103. $ svgo test.svg -o test.min.svg
  104. ```
  105. ```sh
  106. $ svgo test.svg other.svg third.svg
  107. ```
  108. ```sh
  109. $ svgo test.svg other.svg third.svg -o test.min.svg -o other.min.svg -o third.min.svg
  110. ```
  111. * со STDIN / STDOUT:
  112. ```sh
  113. $ cat test.svg | svgo -i - -o - > test.min.svg
  114. ```
  115. * с папками
  116. ```sh
  117. $ svgo -f ../path/to/folder/with/svg/files
  118. ```
  119. или:
  120. ```sh
  121. $ svgo -f ../path/to/folder/with/svg/files -o ../path/to/folder/with/svg/output
  122. ```
  123. ```sh
  124. $ svgo *.svg -o ../path/to/folder/with/svg/output
  125. ```
  126. * со строками:
  127. ```sh
  128. $ svgo -s '<svg version="1.1">test</svg>' -o test.min.svg
  129. ```
  130. или даже с Data URI base64:
  131. ```sh
  132. $ svgo -s 'data:image/svg+xml;base64,…' -o test.min.svg
  133. ```
  134. * с SVGZ:
  135. из `.svgz` в `.svg`:
  136. ```sh
  137. $ gunzip -c test.svgz | svgo -i - -o test.min.svg
  138. ```
  139. из `.svg` в `.svgz`:
  140. ```sh
  141. $ svgo test.svg -o - | gzip -cfq9 > test.svgz
  142. ```
  143. ### Другие способы использования SVGO
  144. * в виде веб-приложения - [SVGOMG](https://jakearchibald.github.io/svgomg/)
  145. * как модуль Node.js – [examples](https://github.com/svg/svgo/tree/master/examples)
  146. * как таск для Grunt – [grunt-svgmin](https://github.com/sindresorhus/grunt-svgmin)
  147. * как таск для Gulp – [gulp-svgmin](https://github.com/ben-eb/gulp-svgmin)
  148. * как таск для Mimosa – [mimosa-minify-svg](https://github.com/dbashford/mimosa-minify-svg)
  149. * как действие папки в OSX – [svgo-osx-folder-action](https://github.com/svg/svgo-osx-folder-action)
  150. * через загрузчик webpack – [image-webpack-loader](https://github.com/tcoopman/image-webpack-loader)
  151. * с помощью бота в Telegram – [svgo_bot](https://github.com/maksugr/svgo_bot)
  152. * как плагин PostCSS - [postcss-svgo](https://github.com/ben-eb/postcss-svgo)
  153. * как плагин для Inkscape – [inkscape-svgo](https://github.com/konsumer/inkscape-svgo)
  154. * как плагин для Sketch - [svgo-compressor](https://github.com/BohemianCoding/svgo-compressor)
  155. * в виде приложения macOS - [Image Shrinker](https://image-shrinker.com)
  156. * как плагин для Rollup - [rollup-plugin-svgo](https://github.com/porsager/rollup-plugin-svgo)
  157. ## Лицензия и копирайты
  158. Данное программное обеспечение выпускается под [лицензией MIT](https://github.com/svg/svgo/blob/master/LICENSE).
  159. Логотип – [Егор Большаков](http://xizzzy.ru/).