flo-bit.dev / tiny-docs
[READ-ONLY] Mirror of https://github.com/flo-bit/tiny-docs. quick setup, simple, minimalistic docs for your github project flo-bit.dev/tiny-docs/
0
Fork 0

Configure Feed

Select the types of activity you want to include in your feed.

update

author
Florian date (Oct 28, 2025, 2:24 AM +0100) commit a868ae24 parent 7faf58bc
+3 -3
+1 -1
.github/workflows/tiny-docs.yml
··· 7 7 description: "Owner/Repo of your tiny-docs source" 8 8 required: false 9 9 type: string 10 - default: flo-bit/tiny-docs 10 + default: flo-bit/tiny-docs@v1 11 11 site: 12 12 description: "Docs site domain (default: https://<owner>.github.io)" 13 13 required: false
+2 -2
README.md
··· 4 4 5 5 1. Enable github pages in the repo settings. Go to _SETTINGS &rarr; PAGES &rarr; SOURCE: Github Actions_ 6 6 7 - 2. Add a new github action e.g. in `.github/workflows/deploy.yml` with the following content: 7 + 2. Add a new github action `.github/workflows/docs.yml` with the following content: 8 8 9 9 ```yaml 10 10 name: Deploy Docs ··· 21 21 22 22 jobs: 23 23 docs: 24 - uses: flo-bit/tiny-docs/.github/workflows/tiny-docs.yml@release/v1 24 + uses: flo-bit/tiny-docs/.github/workflows/tiny-docs.yml@v1 25 25 ``` 26 26 27 27 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>`.