{"repo":"Andrew-Chen-Wang/github-wiki-action","free":true,"listed":false,"github":"https://github.com/Andrew-Chen-Wang/github-wiki-action","clone":"git clone https://github.com/Andrew-Chen-Wang/github-wiki-action.git","description":"📖 GitHub Action to sync a folder to the GitHub wiki","language":"TypeScript","stars":111,"topics":["actions","wiki","github-actions","github-wiki","github-action","bash"],"license":"Apache-2.0","category":"cli-tools","readme_excerpt":"Publish to GitHub wiki 📖 GitHub Action to sync a folder to the GitHub wiki 📂 Keep your dev docs in sync with your code \\ 💡 Inspired by [Decathlon/wiki-page-creator-action#11] \\ 🔁 Able to open PRs with docs updates \\ ✨ Use the fancy GitHub wiki reader UI for docs \\ 🌐 Works across repositories (with a [PAT]) \\ 💻 Supports runs-on: windows- Usage Add a GitHub Actions workflow file to your .github/workflows/ folder similar to the example shown below. ☝ This workflow will mirror the wiki/ folder in your GitHub repository to the user/repo.wiki.git Git repo that houses the wiki documentation! You can use any of the [supported markup languages] like MediaWiki, Markdown, or AsciiDoc. 🔑 In order to successfully push to the .wiki.git Git repository that backs the wiki tab, we need the contents: write permission! Make sure you have something like shown above either for your entire workflow, or just for one particular job. This will give the auto-generated ${{ github.token }} that we use by default permission to push to the .wiki.git repo of the repository that the action runs on. ⚠️ You must create a dummy page manually! This is what initially creates the GitHub wiki Git-based storage backend that we then push to in this Action. After creating your workflow file, now all you need is to put your Markdown files in a wiki/ folder (or whatever you set the path option to) and commit them to your default branch to trigger the workflow (or whatever other trigger you set up). 💡 Each page ","default_branch":null,"files":null,"tree":[],"storefront":"/r/Andrew-Chen-Wang","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Andrew-Chen-Wang/github-wiki-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}