git-wiki

it's a modular and full featured wiki powered by git, github/gitlab pages and pull-requests!

Getting started

The easier and faster way to use git-wiki is the "skeleton" method.

You don't need to install anything locally!

1. Simply fork/clone skeleton repo or click on "Use this template" button to create your copy of the skeleton project.

2. Edit _config.yml and other pages as you need and then deploy it on github/gitlab pages.

Done! now wait that your page will be published and you're ready to wiki!

Features

• Improvements in the cooperative aspect: forks, pull-requests and roles.
• You can customize your wiki as you want with style sheets and even changing the layout. (see customization section below)
• No databases! Only static files that can be downloaded in a few seconds.
• Blazing fast and free thankfully to Github/Gitlab Pages and Jekyll Server Side Generation process!
• Markdown and html mixed together!
• Multiple free search engines! on a static site!
• History, revision comparison and everything you need from a wiki platform.
• You can edit your pages with the standard git editor, prose.io (integrated) or any kind of editor you prefer.
• Non-existent wiki page links are "red", you can click on them to automatically create a new page!
• External links get the right icon automatically
• Component system with hooks that allows you to totally customize your wiki UI. (see customization section below)
• Some nice internal themes to change your entire wiki UI with 1 simple configuration (see customization section below)
• Integrated Blogging feature thanks to jekyll!
• Automatic generated TOC
• You can download the entire wiki for offline usage and even navigate directly using a markdown reader

You can use it with jekyll "remote_theme" feature or fork/copy the master branch and start your wiki in just 1 minute*.

Instructions and full documentation: (http://drassil.github.io/git-wiki)