Home › Software Dev / Git / GitHub / DevOps / ALM › Creating a GitHub Wiki Documentation for Your Repository
Software Dev / Git / GitHub / DevOps / ALM · Mar 5, 2019 · 1 MIN READ

Creating a GitHub Wiki Documentation for Your Repository

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:

 

Carl de Souza
Keep learning. Keep building.

Explore AI, agents & Microsoft technology.

I share practical ideas, tutorials, and videos about AI, AI agents, Microsoft technologies, and the Power Platform.

Subscribe on YouTube →
Carl de Souza Enterprise Architect at Microsoft · AI Technology Expert

Leave a Reply

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

Carl de Souza
KEEP LEARNING. KEEP BUILDING.

Explore AI, agents & Microsoft technology.

I share practical ideas, tutorials, and videos about AI, AI agents, Microsoft technologies, and the Power Platform.