update the index file of your project's siteleaf project with your repository's README.md file

When hosting GitHub Pages, there is a common discrepancy one faces when choosing the place to host their page files.

Hosting GitHub Pages the master branch has the advantage that files can be shared with the project (including the README). However, pages usually stand alone without a dependency to or from the project's files. Hence, there might be numerous commits that cause an avoidable overhead to merges, CI, and pulls.

Hosting the pages on a dedicated branch (e.g., gh-pages) has the benefit that this beforementioned overhead is avoided. Separate concerns are rooted in separate trees, just as it is supposed to be. However, normally, developers only want to publish their README with a few additions. There is no integrated way or known method in GitHub to sync the README file without hooks or different workarounds. This circumstance impairs common maintenance and automation requirements.

1. Use Siteleaf, and publish or sync to a dedicated branch on GitHub.
2. Create a page and assign it a path (i.e. index by default).
3. Setup your CI to use siteleaf-updater for automated doc updates.

steps:
  - name: update site
    uses: gofunky/siteleaf-updater@v2
    with:
      api-key: ${{ secrets.SITELEAF_KEY }}
      api-secret: ${{ secrets.SITELEAF_SECRET }}
      site: 'my-site'
      page: 'contribution'
      file: 'CONTRIBUTION.md'
      publish: true