20

I've used GitHub pages to generate a beautiful website for my project (this one). Now I want to keep the documentation of my project up to date, and having everything in a single README.md file is probably not scalable to the many features we are adding.

So, I thought that the best place to keep the documentation is the GitHub wiki, but I'd like to integrate the wiki to the gh-pages generated site, keeping the beautiful layout.

How would I take the GitHub wiki and generate an HTML web site with a customizable layout?

Mogsdad
  • 44,709
  • 21
  • 151
  • 275
Luigi R. Viggiano
  • 8,659
  • 7
  • 53
  • 66

2 Answers2

7

Here is an example URL for a wiki:

https://github.com/golang/go/wiki

On the same page you will find a clone link:

https://github.com/golang/go.wiki.git

Then run the Markdown files through Hugo or even create a new repository to the host site based on the Wiki.

Zombo
  • 1
  • 62
  • 391
  • 407
2

You could include your wiki as subtree.

BTW, GitHub Pages now no longer need the gh-pages branch. Create a repository named your-user-name.github.io; it will automatic generate to a website. See GitHub Pages for more detail.

Peter Mortensen
  • 30,738
  • 21
  • 105
  • 131
Allen
  • 6,745
  • 5
  • 41
  • 59
  • 2
    There is a difference between a _user_ page (using `*.github.io` method) and a _project_ page (using `gh-pages` method), though. – heltonbiker Apr 06 '16 at 20:57