Creating a GitHub Wiki Documentation for Your Repository

Leave a comment

In this post, we will look at how to create wiki documentation for your GitHub repository. This can be very useful to document your GitHub code.

Let’s go through an example. Go to a GitHub repository, and in the menu you should see Wiki:

Click Create the First Page:

You should see something like below:

We see the title of the page is Home, and it has some basic test. Let’s click Save page. We have now saved our first page.

Notice we can add a custom footer, add a custom sidebar etc. Let’s add a custom footer:

Let’s save the footer:

Our wiki now looks like:

Let’s add a custom sidebar:

Let’s save it:

Let’s add another 2 pages. We now have:

Notice how the pages aren’t grouped. To add grouping, we can use the custom sidebar.

Which displays as:

 

THANKS FOR READING. BEFORE YOU LEAVE, I NEED YOUR HELP.
 

I AM SPENDING MORE TIME THESE DAYS CREATING YOUTUBE VIDEOS TO HELP PEOPLE LEARN THE MICROSOFT POWER PLATFORM.

IF YOU WOULD LIKE TO SEE HOW I BUILD APPS, OR FIND SOMETHING USEFUL READING MY BLOG, I WOULD REALLY APPRECIATE YOU SUBSCRIBING TO MY YOUTUBE CHANNEL.

THANK YOU, AND LET'S KEEP LEARNING TOGETHER.

CARL

https://www.youtube.com/carldesouza

 

ABOUT CARL DE SOUZA

Carl de Souza is a developer and architect focusing on Microsoft Dynamics 365, Power BI, Azure, and AI.

carldesouza.comLinkedIn Twitter | YouTube

 

Leave a Reply

Your email address will not be published. Required fields are marked *