awesome-awesomeness/html/githubwiki.html

<h1
id="awesome-github-wikis-awesome-awesome-lint-track-awesome-list">Awesome
GitHub Wikis <a href="https://awesome.re"><img
src="https://awesome.re/badge.svg" alt="Awesome" /></a> <a
href="https://github.com/MyHoneyBadger/awesome-github-wiki/actions/workflows/action.yml?query=branch%3Amain"><img
src="https://github.com/MyHoneyBadger/awesome-github-wiki/actions/workflows/action.yml/badge.svg?branch=main"
alt="Awesome Lint" /></a> <a
href="https://www.trackawesomelist.com/MyHoneyBadger/awesome-github-wiki/"><img
src="https://www.trackawesomelist.com/badge.svg"
alt="Track Awesome List" /></a></h1>
<blockquote>
<p>A curated list of awesome GitHub Wikis</p>
</blockquote>
<p>Every repository on <a href="https://github.com/">GitHub.com</a>
comes equipped with a section for hosting documentation, called a <a
href="https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis">Wiki</a>.
Repository’s Wiki shares long-form content about project, such as how to
use it, how you designed it, or its core principles. A README file
quickly tells what project can do, while use a Wiki to provide
additional documentation.</p>
<h2 id="contents">Contents</h2>
<ul>
<li><a href="#examples">Examples</a></li>
<li><a href="#useful-links-with-tips--tricks">Useful links with tips
&amp; tricks</a></li>
<li><a href="#useful-stack-overflow-questions--answers">Useful Stack
Overflow questions &amp; answers</a></li>
</ul>
<h2 id="examples">Examples</h2>
<p>Wiki should be detail, up to date and well structured. It should be
easy to find required information and navigate through the pages. Use
rich possibilities of Markdown in Wiki formatting. Wiki doesn’t fully
repeat information which is already presented at README. The following
list of examples represents mentioned good practices:<br />
- <a href="https://github.com/Netflix/Hystrix/wiki">Netflix/Hystrix</a>
- <a
href="https://github.com/aws/aws-parallelcluster/wiki">aws/aws-parallelcluster</a>
- <a href="https://github.com/facebook/hhvm/wiki">facebook/hhvm</a> - <a
href="https://github.com/thinkaurelius/titan/wiki">thinkaurelius/titan</a>
- <a
href="https://github.com/guard/guard/wiki/Guard-2.10.3-exits-when-Guardfile-is-changed">guard/guard</a>
- <a
href="https://github.com/apple/foundationdb/wiki">apple/foundationdb</a>
- <a href="https://github.com/google/guava/wiki">google/guava</a> - <a
href="https://github.com/hyperledger/cacti/wiki">hyperledger/cacti</a> -
<a
href="https://github.com/facebook/react-native/wiki">facebook/react-native</a>
- <a
href="https://github.com/FortAwesome/Font-Awesome/wiki">FortAwesome/Font-Awesome</a>
- <a href="https://github.com/golang/go/wiki">golang/go</a> - <a
href="https://github.com/uber/NullAway/wiki">uber/NullAway</a> - <a
href="https://github.com/internetarchive/openlibrary/wiki">internetarchive/openlibrary</a></p>
<h2 id="useful-links-with-tips-tricks">Useful links with tips &amp;
tricks</h2>
<ul>
<li><a href="https://www.youtube.com/watch?v=bnMl0d-RcPQ">Learning
GitHub - Making Wikis</a></li>
<li><a
href="https://carldesouza.com/creating-a-github-wiki-documentation-for-your-repository/">Creating
a GitHub Wiki documentation for your repository</a></li>
<li><a href="https://www.youtube.com/watch?v=4B0XNThjO0E">Git Tutorial -
24 - GitHub Wiki</a></li>
<li><a href="https://github.com/linyows/github-wiki-search">Search wiki
of the repository on GitHub</a></li>
<li><a
href="http://mikehadlow.blogspot.com/2014/03/how-to-add-images-to-github-wiki.html">How
To Add Images To A GitHub Wiki</a></li>
<li><a
href="https://medium.com/@apcoyne100/github-wiki-markdown-tips-and-examples-1bab1f0c0d25">GitHub
Wiki Markdown tips and examples</a></li>
<li><a
href="https://www.softwaretestinghelp.com/github-projects-teams-fork-wiki">GitHub
Projects, Teams, Fork &amp; Wiki For Documenting Projects</a></li>
<li><a
href="https://sparkbox.com/foundry/github_wiki_tutorial_for_technical_wiki_documentation">Using
GitHub Wiki for Software Development Documentation</a></li>
<li><a
href="https://nimblehq.co/compass/development/documentation/github-wiki/">GitHub
Wiki by Nimble</a></li>
<li><a
href="https://bugherd.com/blog/building-a-better-github-wiki/">Building
a better GitHub Wiki</a></li>
<li><a
href="https://ably.com/blog/hacking-github-to-build-your-own-wiki">Hack
GitHub to build your own wiki in five steps</a></li>
<li><a
href="https://github.blog/changelog/2022-02-14-upload-images-to-wiki-pages/">Upload
images to Wiki pages</a></li>
<li><a href="https://www.learnvern.com/git-and-github-tutorial/wiki">Git
And GitHub Course - Master Git And GitHub - GitHub Wiki</a></li>
<li><a href="https://almanac.io/blog/github-wiki-examples-templates">How
to Use GitHub as a Wiki: Examples &amp; Templates</a></li>
<li><a
href="https://labs.inn.org/2014/05/19/applying-git-to-github-wikis/">How
To Use GitHub Wikis For Collaborative Documentation</a></li>
<li><a
href="https://github.com/marketplace/actions/github-wiki-action">GitHub
Wiki Action. Keep your dev docs in sync with your code</a></li>
</ul>
<h2 id="useful-stack-overflow-questions-answers">Useful Stack Overflow
questions &amp; answers</h2>
<ul>
<li><a
href="https://stackoverflow.com/questions/11804820/how-can-i-embed-a-youtube-video-on-github-wiki-pages">How
can I embed a YouTube video on GitHub Wiki pages?</a></li>
<li><a
href="https://stackoverflow.com/questions/24383700/resize-image-in-the-wiki-of-github-using-markdown">Resize
image in the wiki of GitHub using Markdown</a></li>
<li><a
href="https://stackoverflow.com/questions/6474045/linking-to-other-wiki-pages-on-github">Linking
to other Wiki pages on GitHub?</a></li>
<li><a
href="https://stackoverflow.com/questions/15080848/how-do-i-clone-a-github-wiki">How
do I clone a GitHub Wiki?</a></li>
<li><a
href="https://stackoverflow.com/questions/18244417/how-do-i-create-some-kind-of-table-of-content-in-github-wiki">How
do I create some kind of table of content in GitHub Wiki?</a></li>
<li><a
href="https://stackoverflow.com/questions/11088285/github-wiki-directories">GitHub
Wiki directories</a></li>
<li><a
href="https://stackoverflow.com/questions/11505503/github-wiki-source-code-syntax-highlighting">GitHub
Wiki - Source code syntax highlighting</a></li>
<li><a
href="https://stackoverflow.com/questions/24236829/how-to-structure-github-wiki-files">How
to structure GitHub Wiki files?</a></li>
<li><a
href="https://stackoverflow.com/questions/25706012/how-do-i-prevent-auto-generated-links-in-the-github-wiki">How
do I prevent auto-generated links in the GitHub Wiki?</a></li>
<li><a
href="https://stackoverflow.com/questions/8624865/how-html5-boilerplate-converts-github-wiki-to-its-website">How
HTML5 Boilerplate converts GitHub Wiki to its website?</a></li>
<li><a
href="https://stackoverflow.com/questions/18759738/effortless-export-from-github-wiki">Effortless
export from GitHub Wiki</a></li>
<li><a
href="https://stackoverflow.com/questions/9239588/toc-or-sidebar-in-github-wiki">ToC
or Sidebar in GitHub Wiki</a></li>
<li><a
href="https://stackoverflow.com/questions/45657579/github-wiki-doesnt-support-html-tables-anymore">GitHub
Wiki doesn’t support HTML tables anymore?</a></li>
<li><a
href="https://stackoverflow.com/questions/14901245/how-to-style-a-json-block-in-github-wiki">How
to style a JSON block in GitHub Wiki?</a></li>
</ul>
<h2 id="contributing">Contributing</h2>
<p>Contributions are very welcome! Please read the <a
href="contributing.md">contribution guideline</a> first.</p>