feat: add doc to update the doc

This commit is contained in:
Cyril Hue 2024-08-12 14:11:01 +02:00
parent bc14adcaf1
commit 911335a1cb
9 changed files with 414 additions and 380 deletions

View File

@ -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)
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)**
---

View File

@ -1 +1,25 @@
# Update existing documentation
# 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
+ <div class="icon">
```
Replace `fdn` with the short code of the new icon.
3. Add the new icon usage inside the `icons.html`.
```diff
+ <div class="icon" id="fdn" name="Foundation" data-name="Foundation" data-class="fdn" data-unicode="x1f31f" data-added="v3.14.0">
+ <span class="name"><i class="ss ss-fdn"></i> Foundation <em>(fdn)</em></span>
+ </div>
```
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. 🙏

View File

@ -171,6 +171,7 @@
<span class="utf"><i>&#xe669;</i> ss-evg <code>&amp;#xe669;</code></span>
<span class="utf"><i>&#xe621;</i> ss-exo <code>&amp;#xe621;</code></span>
<span class="utf"><i>&#xe69a;</i> ss-exp <code>&amp;#xe69a;</code></span>
<span class="utf"><i>&#x1f31f;</i> ss-fdn <code>&amp;#x1f31f;</code></span>
<span class="utf"><i>&#xe617;</i> ss-fem <code>&amp;#xe617;</code></span>
<span class="utf"><i>&#xe654;</i> ss-frf <code>&amp;#xe654;</code></span>
<span class="utf"><i>&#xe63c;</i> ss-fut <code>&amp;#xe63c;</code></span>

Binary file not shown.

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 922 KiB

After

Width:  |  Height:  |  Size: 930 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -452,6 +452,9 @@
<div class="icon" id="blb" name="Bloomburrow" data-name="Bloomburrow" data-class="blb" data-unicode="e9cd" data-added="v3.14.0">
<span class="name"><i class="ss ss-blb"></i> Bloomburrow <em>(blb)</em></span>
</div>
<div class="icon" id="fdn" name="Foundation" data-name="Foundation" data-class="fdn" data-unicode="x1f31f" data-added="v3.14.0">
<span class="name"><i class="ss ss-fdn"></i> Foundation <em>(fdn)</em></span>
</div>
</div>
</section>
<section class="content">