|
|
||
|---|---|---|
| .. | ||
| __mocks__ | ||
| __snapshots__ | ||
| templates | ||
| build.js | ||
| package.json | ||
| readme.md | ||
| write-initial-tree.js | ||
| write-initial-tree.test.js | ||
| write-tree.js | ||
| write-tree.test.js | ||
| yarn.lock | ||
GitHub Build
Instead of building a website, I wanted to try constructing GitHub readmes linked from one to the other. As the project is simple, I thought it could be a decent choice.
My opinion
Unfortunately, it's not possible to display videos in GitHub Flavored Markdown. Images can't be sized using HTML width and height to avoid Cumulative Layout Shift.
Apart from that I'm sure it could be used for real small projects as it avoids setting up anything else.
How does it work?
The build-github.yml GitHub Action workflow is triggered when the defaults.yml file or the related build scripts are updated.
This workflow compile a dist folder where gitmoji-changelog is run and everything is commited and pushed to the current branch.
There is also some complicated stuff to build a clean initial commit, that's the point of write-initial-tree.js.
The GitHub action that runs gitmoji-changelog and pushes to the other branch can be found on gha-publish-to-git.
Try locally
🏗 Install
yarn install
🚀 Usage
This will build the defaults.yml file to a dist and a dist-initial folders containing GitHub Flavored Markdown files.
yarn build
It's not yet possible to launch a webserver to preview it locally.
🚧 Run unit tests
yarn test