https://github.com/victor-public/wiki-automation
Action to sync your WIKI with one of the folders in your repository.
https://github.com/victor-public/wiki-automation
action automation documentation sync wiki
Last synced: about 2 months ago
JSON representation
Action to sync your WIKI with one of the folders in your repository.
- Host: GitHub
- URL: https://github.com/victor-public/wiki-automation
- Owner: victor-public
- License: mit
- Created: 2025-03-08T20:31:15.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-16T08:46:49.000Z (over 1 year ago)
- Last Synced: 2025-03-16T09:24:24.941Z (over 1 year ago)
- Topics: action, automation, documentation, sync, wiki
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# wiki-automation
This action sync your repository wiki with the contents of one of your folders. So you can document your project along with your codebase.
## Use case
There is a reason project documentation is hard: **we tend to overlook writing docs**.
This is particularly true, when your docs tooling are totally separate from your codebase:
> _Docstrings?_ They need to be compiled, and they too rigid.
> _Wiki pages?_ Yeah, but you need to abandon your IDE to update them
By using this action we can automate [Github Wiki management](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis), while we edit our documentation files along with our codebase. This is our proposed workflow:
- Dedicate a folder in your code-base to host your documentaion. Say `~/docs`
- Write down all your docs in `.md` files.
- Use [mermaid](https://github.blog/developer-skills/github/include-diagrams-markdown-files-mermaid/) to draw diagrams.
- Add a preview [extension in your IDE](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid). So you get instant feedback on how it looks.
- When you push to main, the action will update your repository wiki.
And you are done.
### :eyes: How to make it look good?
Remember to include two special `.md` files at your docs folder:
- `_Sidebar.md`: your Wiki's side-bar menu.
- `_Footer.md`: your Wiki's footer
All [Github's emojis](https://gist.github.com/rxaviers/7360908) are allowed.
## How to use this action?
These are the action's available parameters:
| Name | Required | Description |
| --- | --- | --- |
| token | Yes | GITHUB_TOKEN or PAT with appropiate permissions |
| repository | Yes | Use `${{ github.repository }}` |
| docs-folder | Yes | The folder to be sync-ed with your repository's Wiki |
| user-name | No | Your `git config user.name` (Default: `BOT`) |
| user-email | No | Your `git config user.email` (Default: `bot@bot.com` |
Assuming you wrote your documentation at `~/docs`, this is an example workflow to on `push`:
```yml
on:
push:
branches: main
paths:
- docs/**
concurrency:
group: update-wiki
cancel-in-progress: true
jobs:
update-wiki:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: victor-public/wiki-automation@master
with:
token: ${{ secrets.GITHUB_TOKEN }}
repository: ${{ github.repository }}
docs-folder: docs
```
## Did you find this action useful?
Support me, so I can keep publishing good stuff:
[](https://github.com/sponsors/victor-public)