Skip to content

Learn About Wikis

Alexandra Bourne edited this page Apr 22, 2021 · 1 revision

Welcome to the github-slideshow wiki!

About wikis You can host documentation for your repository in a wiki, so that others can use and contribute to your project.

Wikis are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products."

Every GitHub repository comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "About READMEs."

With wikis, you can write content just like everywhere else on GitHub. For more information, see "Getting started with writing and formatting on GitHub." We use our open-source Markup library to convert different formats into HTML, so you can choose to write in Markdown or any other supported format.

Clone this wiki locally