Tiny docs#

How to use#

1. Enable github pages in the repo settings. Go to SETTINGS → PAGES → SOURCE: Github Actions

2. Add a new github action .github/workflows/docs.yml with the following content:

name: Deploy Docs

on:
    push:
        branches: [main]
    workflow_dispatch:

permissions:
    contents: read
    pages: write
    id-token: write

jobs:
    docs:
        uses: flo-bit/tiny-docs/.github/workflows/tiny-docs.yml@v1

3. Run the workflow manually or push to the main branch, after a minute or two your docs should be live at https://<yourusername>.github.io/<yourrepo>.

The docs will include all markdown files in the docs/ folder of your repo as well as the Readme.md file.