flo-bit.dev
[READ-ONLY] Mirror of https://github.com/flo-bit/shapecraft.
flo-bit.dev/shapecraft/
771 B
29 lines
1# Tiny docs
2
3quick to setup, simple, minimalistic docs for your github project
4
5## How to use
6
71. Enable github pages in the repo settings. Go to _SETTINGS → PAGES → SOURCE: Github Actions_
8
92. Add a new github action `.github/workflows/docs.yml` with the following content:
10
11```yaml
12name: Deploy Docs
13
14on:
15 push:
16 branches: [main]
17
18permissions:
19 id-token: write
20 pages: write
21
22jobs:
23 docs:
24 uses: flo-bit/tiny-docs/.github/workflows/tiny-docs.yml@v1
25```
26
273. 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
29The docs will include all markdown files in the `docs/` folder of your repo as well as the `Readme.md` file.