The GitHub wiki Markdown template can be used to generate GitHub compatible wiki pages. This section contains various details on how to best support GitHub wiki pages.
Activate wikis in a GitHub repository
To activate wikis in a GitHub repository, you need to go to your repository's main page, click on the "General" tab, scroll down to the "Features" section, and then check the box next to "Wikis". This will enable the wiki feature for your repository.
For more detailed information, you can refer to the official GitHub documentation page on enabling wikis in a repository: Enabling wiki support.
Updating your GitHub repository's wiki pages
You first need to clone your GitHub repository's Wiki pages locally by following these steps:
- Go to the GitHub repository that contains the Wiki you want to clone.
- Use the git clone command followed by the URL of the Wiki to clone the Wiki repository locally. To access the repository's Wiki URL, simply add the ".wiki.git" at the end of the repository's name. For example:
git clone https://github.com/<YOUR-USERNAME>/<YOUR-REPOSITORY>.wiki.git
To update the Wiki pages and push the modified content back to the repository, you can do the following:
- Generate your content from HelpNDoc in the local cloned repository
- Once you have made the updates, navigate to the directory where you cloned the Wiki repository using the terminal
- Use the following commands to add the changes, commit them, and push them to the repository:
git add .
git commit -m "Updated Wiki pages with new content"
git push