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.

commit

author
Florian date (Oct 28, 2025, 11:28 AM +0100) commit a8d6f6bd parent 048d00b9
+18 -5
+15
.github/workflows/docs.yml
··· 1 + name: Deploy Docs 2 + 3 + on: 4 + push: 5 + branches: [main] 6 + workflow_dispatch: 7 + 8 + permissions: 9 + contents: read 10 + pages: write 11 + id-token: write 12 + 13 + jobs: 14 + docs: 15 + uses: flo-bit/tiny-docs/.github/workflows/tiny-docs.yml@v1
-2
.github/workflows/tiny-docs.yml
··· 22 22 type: string 23 23 24 24 permissions: 25 - contents: read 26 25 pages: write 27 - id-token: write 28 26 29 27 jobs: 30 28 build:
+3 -3
README.md
··· 1 1 # Tiny docs 2 2 3 + quick to setup, simple, minimalistic docs for your github project 4 + 3 5 ## How to use 4 6 5 7 1. Enable github pages in the repo settings. Go to _SETTINGS &rarr; PAGES &rarr; SOURCE: Github Actions_ ··· 12 14 on: 13 15 push: 14 16 branches: [main] 15 - workflow_dispatch: 16 17 17 18 permissions: 18 19 contents: read 19 20 pages: write 20 - id-token: write 21 21 22 22 jobs: 23 23 docs: 24 24 uses: flo-bit/tiny-docs/.github/workflows/tiny-docs.yml@v1 25 25 ``` 26 26 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>`. 27 + 3. The workflow will run automatically when you push to the main branch, after a minute or two your docs should be live at `https://<yourusername>.github.io/<yourrepo>`. 28 28 29 29 The docs will include all markdown files in the `docs/` folder of your repo as well as the `Readme.md` file.