File size: 1,202 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# README Updater
*A tool / script that generates [` README.md `][README] .*
<br>
## Description
This script replaces markers in [` docs/Template.md `][Template] <br>
with linked icons generated from the data found in <br>
[` docs/Helpers.yaml `][Helpers] and [` docs/Sponsors.yaml `][Sponsors] .
<br>
<br>
## Markers
A marker is placed at the start of a line.
<br>
### Syntax
```markdown
~Marker_Id
```
<br>
### Types
- `Sponsors`
*Generates icons for sponsors.*
- `Helpers`
*Generates icons for helpers.*
<br>
<br>
## Requirements
*Things you need if you run it manually.*
- **[Deno]**
<br>
<br>
## Running
*Manual execution of the tool.*
<br>
```shell
deno run \
--allow-read \
--allow-write \
--importmap=scripts/README/Imports.json \
scripts/README/Updater.js
```
<br>
<!----------------------------------------------------------------------------->
[Sponsors]: ../../docs/Sponsors.yaml
[Template]: ../../docs/Template.md
[Helpers]: ../../docs/Helpers.yaml
[README]: ../../README.md
[Deno]: https://deno.land/ |