CODEWITHSUNDEEP
githubdocumentationwikidocumentation-generationgithub-pages
Luigi
Luigi

Reputation: 8847

How to generate a website from GitHub wiki pages

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?

Upvotes: 20

Views: 8593

Answers (2)

Zombo
Zombo

Reputation: 1

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.

Upvotes: 6

Allen
Allen

Reputation: 6882

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.

Upvotes: 2

Related Questions