Wikis: now with more love
Documenting the code you share on GitHub can contribute tremendously to the success of your project. When your documentation is easy to access and read, people can better understand how…
Documenting the code you share on GitHub can contribute tremendously to the success of your project. When your documentation is easy to access and read, people can better understand how to work with your code and how to contribute as collaborators.
Today we’re shipping several UI improvements that make it easier to create, edit, and interact with GitHub Wikis. These changes also make wiki content more consistent with other repository features and pave the way for future updates.
GitHub Wikis now feature:
- an upgraded sidebar that lists all of the pages in your wiki along with any custom content you’d like to include
- more consistent rendering of wiki content alongside other markup in a repository
-
emoji
👍 - task lists
If you haven’t yet enabled a wiki for your project, we’ve published a Guide to help you get started, and have compiled a showcase of projects that have fantastic wikis for inspiration. Need more help? Check out our revamped documentation articles.
Written by
Related posts
GitHub Availability Report: November 2024
In November, we experienced one incident that resulted in degraded performance across GitHub services.
The top 10 gifts for the developer in your life
Whether you’re hunting for the perfect gift for your significant other, the colleague you drew in the office gift exchange, or maybe (just maybe) even for yourself, we’ve got you covered with our top 10 gifts that any developer would love.
Congratulations to the winners of the 2024 Gaady Awards
The Gaady Awards are like the Emmy Awards for the field of digital accessibility. And, just like the Emmys, the Gaadys are a reason to celebrate! On November 21, GitHub was honored to roll out the red carpet for the accessibility community at our San Francisco headquarters.