Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/icons.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Otto <markdotto@gmail.com>2019-09-16 06:33:04 +0300
committerXhmikosR <xhmikosr@gmail.com>2019-09-16 13:17:03 +0300
commiteb0b9b039cf6790e36ddb0b4c22f14f1810f9c4d (patch)
tree21f3da9e28dd50e2f199a6f9b8e646edeae5c2af /README.md
parent066461320389a19591df5dd71c47d707c518820c (diff)
Rewrite the JS for handling attributes, their values, and their order
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 99078228f..066e8bc7f 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,15 @@ npm start
Then open `http://localhost:4000` in your browser.
+## Adding SVGs
+
+Once a new SVG icon has been added to the `icons` directory, you'll need to prep and build them. Two npm scripts are used to optimize and modify the HTML source code of our SVGs.
+
+1. `npm run icons-prep` runs SVGO on our SVGs.
+2. `npm run icons-build` processes the HTML, removes all attributes, and then sets new attributes and values in a particular order.
+
+Use `npm run icons` to run them in order, then commit the results in a new branch for updating.
+
## Publishing
Docs are published via an npm script that builds the Hugo site, creates a temporary Git repo, and force pushes that to our `gh-pages` branch. This circumvents issues with GitHub Pages not working with Hugo.