diff --git a/contributing/GenerateCss.md b/contributing/GenerateCss.md index 8e9d21b..4f28f68 100644 --- a/contributing/GenerateCss.md +++ b/contributing/GenerateCss.md @@ -7,16 +7,20 @@ Generate the CSS file with the following command: ```bash -npm run lessmin & sassmin +npm run lessmin && npm run sassmin ``` or for debug purpose you can run ```bash -npm run less & sass +npm run less && npm run sass ``` 2 files will be generated in the `css` folder: `keyrune.css` and `keyrune.min.css`. ![generate-css](./images/generate-css.png) -Yaay 🎉 you have generate the CSS file! Now you can use the new icon in the website. Follow the [Usage inside README.md](../README.md#usage) \ No newline at end of file +Yaay 🎉 you have generate the CSS file! Now you can use the new icon in the website. Follow the [Usage inside README.md](../README.md#usage) + +--- +**Go to the next step: [Update the documentation](./UpdateDocumentation.md)** +--- \ No newline at end of file diff --git a/contributing/UpdateDocumentation.md b/contributing/UpdateDocumentation.md index be86719..7b9d8b1 100644 --- a/contributing/UpdateDocumentation.md +++ b/contributing/UpdateDocumentation.md @@ -1 +1,25 @@ -# Update existing documentation \ No newline at end of file +# Update existing documentation + +After you have added a new set icon, update the codebase and generate the new `keyrune.css` file, you need to update the documentation to reflect the changes. + +## Steps + +1. Run this command + ```bash + npm run build + ``` + This will copy fonts and css files to the `docs` folder. +2. Add the new icon usage inside the `cheatsheet.html`. + ```diff + +
+ ``` + Replace `fdn` with the short code of the new icon. +3. Add the new icon usage inside the `icons.html`. + ```diff + +
+ + Foundation (fdn) + +
+ ``` + Replace `fdn` with the short code of the new icon. + + > A data attribute with the version is present, but i don't know how it's working. If you have info about it, please add it in this doc here. 🙏 \ No newline at end of file diff --git a/docs/cheatsheet.html b/docs/cheatsheet.html index b8cfc81..1472777 100644 --- a/docs/cheatsheet.html +++ b/docs/cheatsheet.html @@ -171,6 +171,7 @@ ss-evg  ss-exo  ss-exp  + 🌟 ss-fdn 🌟 ss-fem  ss-frf  ss-fut  diff --git a/docs/fonts/keyrune.eot b/docs/fonts/keyrune.eot index f3238fe..fa8e638 100644 Binary files a/docs/fonts/keyrune.eot and b/docs/fonts/keyrune.eot differ diff --git a/docs/fonts/keyrune.svg b/docs/fonts/keyrune.svg index d7a7321..35797e7 100644 --- a/docs/fonts/keyrune.svg +++ b/docs/fonts/keyrune.svg @@ -5,14 +5,14 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/keyrune.ttf b/docs/fonts/keyrune.ttf index 530bbc2..a3515f8 100644 Binary files a/docs/fonts/keyrune.ttf and b/docs/fonts/keyrune.ttf differ diff --git a/docs/fonts/keyrune.woff b/docs/fonts/keyrune.woff index da9c8d7..0c7d41a 100644 Binary files a/docs/fonts/keyrune.woff and b/docs/fonts/keyrune.woff differ diff --git a/docs/fonts/keyrune.woff2 b/docs/fonts/keyrune.woff2 index aed768b..bac26fb 100644 Binary files a/docs/fonts/keyrune.woff2 and b/docs/fonts/keyrune.woff2 differ diff --git a/docs/icons.html b/docs/icons.html index ce0bcf8..c053108 100644 --- a/docs/icons.html +++ b/docs/icons.html @@ -452,6 +452,9 @@
Bloomburrow (blb)
+
+ Foundation (fdn) +