andrew/keyrune
andrew/keyrune
1
0
Fork 0
mirror of https://github.com/andrewgioia/keyrune.git synced 2024-09-29 03:24:46 +00:00
Code Issues Projects Releases Wiki Activity

chore: update contributing

Browse Source
This commit is contained in:
Cyril Hue 2024-08-24 15:51:19 +02:00
parent f459655d24
commit 97f9563db0
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
contributing/UpdateDocumentation.md
View File

@ -11,12 +11,12 @@ After you have added a new set icon, update the codebase and generate the new `k
This will copy fonts and css files to the `docs` folder. This will copy fonts and css files to the `docs` folder.
2. Add the new icon usage inside the `cheatsheet.html`. 2. Add the new icon usage inside the `cheatsheet.html`.
```diff ```diff
+ <div class="icon"> + <span class="utf"><i>&#xe9d8;</i> ss-fdn <code>&amp;#xe9d8;</code></span>
``` ```
Replace `fdn` with the short code of the new icon. Replace `fdn` with the short code of the new icon.
3. Add the new icon usage inside the `icons.html`. 3. Add the new icon usage inside the `icons.html`.
```diff ```diff
+ <div class="icon" id="fdn" name="Foundation" data-name="Foundation" data-class="fdn" data-unicode="x1f31f" data-added="v3.14.0"> + <div class="icon" id="fdn" name="Foundation" data-name="Foundation" data-class="fdn" data-unicode="xe9d8" data-added="v3.14.0">
+ <span class="name"><i class="ss ss-fdn"></i> Foundation <em>(fdn)</em></span> + <span class="name"><i class="ss ss-fdn"></i> Foundation <em>(fdn)</em></span>
+ </div> + </div>
``` ```

2
contributing/UpdateFonts.md
View File

@ -51,4 +51,4 @@ Yaay 🎉 you have update the keyrune font! And have your new icon available.
## Extra steps ## Extra steps
One files is missing inside the generated fonts, it's the `keyrune.woff2`. To get it you need to convert the `keyrune.woff` with online tools like [Cloudconvert](https://cloudconvert.com/woff-to-woff2) One files is missing inside the generated fonts, it's the `keyrune.woff2`. To get it you need to convert the `keyrune.woff` with online tools like [Cloudconvert](https://cloudconvert.com/)