Back to React Hook Form

README Updater

scripts/README/README.md

7.75.01.2 KB
Original Source

README Updater

A tool / script that generates   README.md  .

Description

This script replaces markers in   docs/Template.md 

with linked icons generated from the data found in

 docs/Helpers.yaml   and   docs/Sponsors.yaml  .

Markers

A marker is placed at the start of a line.

Syntax

markdown
~Marker_Id

Types

  • Sponsors

    Generates icons for sponsors.

  • Helpers

    Generates icons for helpers.

Requirements

Things you need if you run it manually.

Running

Manual execution of the tool.

shell
deno run                                    \
    --allow-read                            \
    --allow-write                           \
    --importmap=scripts/README/Imports.json \
    scripts/README/Updater.js
<!----------------------------------------------------------------------------->