Jekyll Themes & Templates Logo Jekyll Themes & Templates
Git Wiki Theme screenshot

Git Wiki Theme

Author Avatar Theme by Drassil
Updated: 24 Dec 2024
218 Stars

A revolutionary full-featured wiki for github pages and jekyll. You don't need to compile it!

Github Live Preview

Overview

Git-wiki is a modular and full-featured wiki powered by Git, GitHub/Gitlab Pages, and pull requests. It consists of three different repositories: git-wiki-theme, git-wiki-skeleton, and git-wiki. Git-wiki allows users to create and customize their own wiki projects using the provided theme and skeleton.

Features

  • Improved Cooperative Aspect: Git-wiki supports forks, pull requests, and roles, making collaboration easier.
  • Customization: Users can customize their wikis with stylesheets and change the layout to fit their needs.
  • No Databases: The wiki is built using static files, making it fast and easy to download.
  • Blazing Fast and Free: Thanks to GitHub/Gitlab Pages and the Jekyll Server Side Generation process, the wiki is both fast and free to use.
  • Markdown and HTML Support: Users can use a combination of Markdown and HTML to create and format content.
  • Multiple Search Engines: The wiki supports multiple free search engines on a static site.
  • History and Revision Comparison: Users can view the revision history and compare different versions of a page.
  • Easy Page Creation: Non-existent wiki page links are highlighted in red and can be clicked to automatically create a new page.
  • Automatic Icon Generation: External links automatically receive the appropriate icon.
  • Component System with Hooks: Git-wiki offers a component system with hooks that allows for complete customization of the wiki’s user interface.
  • Internal Themes: Users can easily change the entire wiki’s UI with a single configuration.
  • Integrated Blogging Feature: Thanks to Jekyll, Git-wiki includes an integrated blogging feature.
  • Automatically Generated Table of Contents: Git-wiki automatically generates a table of contents for each page.
  • Offline Usage: Users can download the entire wiki for offline usage and navigate using a Markdown reader.
  • Flexible Setup: Git-wiki can be used with the Jekyll “remote_theme” feature or by forking/copying the master branch.

Installation

To install git-wiki, follow these steps:

  1. Fork or clone the git-wiki-skeleton repository or use it as a template.
  2. Update the _config.yml file and customize other pages as needed.
  3. Deploy the modified repository on GitHub/Gitlab Pages.
  4. Wait for the page to be published.
  5. Enjoy using git-wiki for your documentation needs!

Summary

Git-wiki is a feature-rich wiki system powered by Git, GitHub/Gitlab Pages, and pull requests. It offers numerous customization options, fast performance, and easy collaboration. With its support for Markdown and HTML, multiple search engines, and integrated blogging feature, git-wiki is a versatile solution for creating and managing wiki-based documentation projects.