Welcome to git-wiki demo
This is both documentation and demo of git-wiki theme for jekyll.
it’s a modular and full featured wiki powered by git, github pages and pull-requests!
- 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 Pages and Jekyll Server Side Generation process!
- Markdown and html mixed together!
- 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”
- 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!
You can fork/copy the master branch now and start your wiki in just 1 minute.
Note: You can even include the official github wiki as a submodule and enable the option in our conf file to use github wiki pages in git-wiki system, but it’s an experimental feature and it implies less advantages and greater disadvantages for now.
Who is using git-wiki
share your wiki with us! and keep the “Power by Git-Wiki” footer link please. It will help both of us!
Fork or copy this repository
copy and rename _config.yml.dist in _config.yml changing settings inside
create your index.md in root directory
push your changes in your repository, then configure the github pages in your repository settings
Your wiki is ready!
We suggest the creation of a /wiki/ subfolder that collects all your .md pages (except index.md)
If you need to work on git-wiki locally before publish, then clone your wiki repo and follow this instructions from official github article: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/ Git wiki already contains the Gemfile for local installations.
Configuration and customization
Read documentation about Customization HERE
Current known limitations
- You can’t use the wiki internal link format: [[example]]. Please, use gh-pages links instead: [example](example) . It’s a known jekyll limitation: https://jekyllrb.com/docs/templates/
Support & Collaboration