a simple opinionated static site generator
MIT License
node library project template
Using GitHub Actions
npm audit
before releasing / testing to keep a higher security standard@ahmadnassri/action-template-repository-sync
Using Docker Compose
Automated through
@ahmadnassri/action-template-repository-sync
NPM_TOKEN
& GH_TOKEN
colophon.yml
, docs/README.md
with info about the projectNote:
GH_TOKEN
is required for actionauto-merge
,readme
,release
workflows
use Docker Compose to run tasks locally:
docker compose run readme
to regenerate README.md
docker compose run test
to run tests across all LTS versions of Node.jsdocker compose run lint
to execute mega-linter locallyNote: Your main
README.md
file is indocs/README.md
, the file at root is generated using pandoc using the provided template.You should run
docker compose run readme
after any change todocs/README.md
and before commit / push
Author: Ahmad Nassri • Twitter: @AhmadNassri