{"id":26455046,"url":"https://github.com/victor-public/wiki-automation","last_synced_at":"2026-05-06T12:49:45.797Z","repository":{"id":281403617,"uuid":"945173179","full_name":"victor-public/wiki-automation","owner":"victor-public","description":"Action to sync your WIKI with one of the folders in your repository.","archived":false,"fork":false,"pushed_at":"2025-03-16T08:46:49.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T09:24:24.941Z","etag":null,"topics":["action","automation","documentation","sync","wiki"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victor-public.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["victor-public"]}},"created_at":"2025-03-08T20:31:15.000Z","updated_at":"2025-03-16T09:12:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"7dd42c8f-d1e2-48d6-a9bd-1fe0f74dbfb3","html_url":"https://github.com/victor-public/wiki-automation","commit_stats":null,"previous_names":["victor-public/wiki-automation"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victor-public%2Fwiki-automation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victor-public%2Fwiki-automation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victor-public%2Fwiki-automation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victor-public%2Fwiki-automation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victor-public","download_url":"https://codeload.github.com/victor-public/wiki-automation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244300890,"owners_count":20430834,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","automation","documentation","sync","wiki"],"created_at":"2025-03-18T20:29:46.365Z","updated_at":"2026-05-06T12:49:40.752Z","avatar_url":"https://github.com/victor-public.png","language":null,"funding_links":["https://github.com/sponsors/victor-public"],"categories":[],"sub_categories":[],"readme":"# wiki-automation\n\nThis action sync your repository wiki with the contents of one of your folders. So you can document your project along with your codebase.\n\n## Use case\n\nThere is a reason project documentation is hard: **we tend to overlook writing docs**. \n\nThis is particularly true, when your docs tooling are totally separate from your codebase:\n\n\u003e _Docstrings?_ They need to be compiled, and they too rigid.  \n\u003e _Wiki pages?_ Yeah, but you need to abandon your IDE to update them \n\nBy 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:\n\n- Dedicate a folder in your code-base to host your documentaion. Say `~/docs`\n- Write down all your docs in `.md` files.\n- Use [mermaid](https://github.blog/developer-skills/github/include-diagrams-markdown-files-mermaid/) to draw diagrams.\n- 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.\n- When you push to main, the action will update your repository wiki.\n\nAnd you are done.\n\n### :eyes: How to make it look good?\n\nRemember to include two special `.md` files at your docs folder: \n\n- `_Sidebar.md`: your Wiki's side-bar menu.\n- `_Footer.md`: your Wiki's footer\n\nAll [Github's emojis](https://gist.github.com/rxaviers/7360908) are allowed.\n\n## How to use this action?\n\nThese are the action's available parameters:\n\n| Name | Required | Description |\n| ---  | ---      | ---         |\n| token | Yes | GITHUB_TOKEN or PAT with appropiate permissions |\n| repository | Yes | Use `${{ github.repository }}` |\n| docs-folder | Yes | The folder to be sync-ed with your repository's Wiki |\n| user-name | No | Your `git config user.name` (Default: `BOT`) |\n| user-email | No | Your `git config user.email` (Default: `bot@bot.com` |\n\nAssuming you wrote your documentation at `~/docs`, this is an example workflow to on `push`: \n\n```yml\non:\n    push:\n        branches: main\n        paths:\n            - docs/**\n\nconcurrency:\n  group: update-wiki\n  cancel-in-progress: true\n\njobs:\n  update-wiki:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          fetch-depth: 0\n      - uses: victor-public/wiki-automation@master\n        with:\n          token: ${{ secrets.GITHUB_TOKEN }}\n          repository: ${{ github.repository }}\n          docs-folder: docs\n```\n\n\n## Did you find this action useful?\n\nSupport me, so I can keep publishing good stuff:\n\n[![](https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=%23fe8e86)](https://github.com/sponsors/victor-public)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictor-public%2Fwiki-automation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictor-public%2Fwiki-automation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictor-public%2Fwiki-automation/lists"}