# Tiny docs

quick to setup, simple, minimalistic docs for your github project

## How to use

1. Enable github pages in the repo settings. Go to _SETTINGS &rarr; PAGES &rarr; SOURCE: Github Actions_

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

```yaml
name: Deploy Docs

on:
    push:
        branches: [main]

permissions:
    id-token: write
    pages: write

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

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>`.

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

More:

- [Configuration](./docs/01-configuration.md)
- [Internal links](./docs/02-internal-links.md)
- [Embeds](./docs/03-embeds.md)
- [Customizing](./docs/04-customizing.md)
