Vic-bot-boss
commented
5 months ago Creating a footer or sidebar for your wiki You can add a custom sidebar or footer to your wiki to provide readers with more contextual information.
Who can use this feature? 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 plans."
In this article Creating a footer Creating a sidebar Creating a footer or sidebar locally Creating a footer On GitHub.com, navigate to the main page of the repository.
Under your repository name, click Wiki.
Screenshot of the menu in a repository. The "Wiki" option is outlined in dark orange. At the bottom of the page, click Add a custom footer.
Use the text editor to type the content you want your footer to have.
In the "Edit message" field, enter a commit message describing the footer you’re adding.
To commit your changes to the wiki, click Save Page.
Creating a sidebar On GitHub.com, navigate to the main page of the repository.
Under your repository name, click Wiki.
Screenshot of the menu in a repository. The "Wiki" option is outlined in dark orange. Click Add a custom sidebar on the right side of the page.
Use the text editor to add your page's content.
In the "Edit message" field, enter a commit message describing the sidebar you’re adding.
To commit your changes to the wiki, click Save Page
About wikis You can host documentation for your repository in a wiki, so that others can use and contribute to your project.
Who can use this feature? 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 plans."
Every repository on GitHub.com 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.
You can use Markdown to add rendered math expressions, diagrams, maps, and 3D models to your wiki. For more information on creating rendered math expressions, see "Writing mathematical expressions." For more information on creating diagrams, maps and 3D models, see "Creating diagrams."
If you create a wiki in a public repository, the wiki is available to the public. If you create a wiki in a private repository, only people with access to the repository can access the wiki. For more information, see "Setting repository visibility."
You can edit wikis directly on GitHub, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on GitHub.com to contribute to a wiki in a public repository. For more information, see "Changing access permissions for wikis."
Note: Search engines will only index wikis with 500 or more stars that you configure to prevent public editing. For more information, see "Changing access permissions for wikis."
If you need search engines to index your content, you can use GitHub Pages in a public repository.