Skip to content
A revolutionary full-featured wiki for github pages and jekyll. You don't need to compile it!
CSS HTML JavaScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.env-files upgraded docker & gemfile Jan 10, 2020
.github/ISSUE_TEMPLATE
_includes avoid default wiki folder in action buttons Jan 13, 2020
_layouts implemented static TOC #57 Jan 11, 2020
_posts v2.1.0 with blog feature implemented Dec 17, 2018
_sass Implemented external links icon (wikipedia style) Dec 31, 2018
assets improved red-link check Jan 12, 2020
wiki removed useless headers Jan 12, 2020
.gitignore Fixed .gitignore Jan 11, 2020
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Dec 21, 2018
CONTRIBUTING.md Create CONTRIBUTING.md Dec 21, 2018
LICENSE
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Dec 21, 2018
README.md
_config.yml minor fix Jan 13, 2020
docker-compose.yml upgraded docker & gemfile Jan 10, 2020
sync-wiki.sh uploaded sources Apr 14, 2017

README.md

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)

You can’t perform that action at this time.