Gollum

Gollum is a Git-powered wiki engine and content management system that provides a web-based interface for editing and organizing files stored in a Git repository. It functions as a self-hosted documentation tool, using a Git-based storage backend to manage page content and track version history.

The system is characterized by a pluggable markup rendering architecture that converts multiple markup languages and specialized notations into HTML. It supports a wide array of rich content, including mathematical typesetting, BibTeX bibliographies, and diagrams rendered via Mermaid.

Broad capabilities include identity management through single sign-on integration, collaborative authoring tools with inline annotations, and full-text repository search. The platform also provides extensibility via hook-based logic extensions, template-based UI overrides, and adapter-based data persistence.

The application can be deployed as a web service, a background daemon, or via container images.

Features

Versioned Wikis - Functions as a wiki engine that utilizes a Git repository as a version-controlled backend for content storage.

Git Content Management Interfaces - Provides a web-based interface for editing and managing content stored in Git repositories.

Self-Hosted Knowledge Bases - Provides a self-hosted platform for private internal knowledge management and information retrieval.

Self-Hosted Documentation Tooling - Provides a self-hosted web frontend for managing and rendering structured documentation stored in version control.

Dynamic Markup Rendering - Provides a system for converting various markup languages into web content dynamically from files.

Git-Based Content Management Systems - Implements a content management system that uses Git repositories as the primary storage and versioning backend.

Data Storage Adapters - Uses a modular adapter pattern to decouple application logic from the underlying storage backend.

Version History Managers - Tracks page changes over time to allow users to view commit diffs and revert to previous versions.

Markup Formatting Engines - Implements a pluggable architecture to convert multiple markup languages and specialized notations into HTML.

Collaborative Editing Tools - Supports collaborative authoring with inline annotations, page drafts, and version history.

Content Formats - Configures the supported markups and data formats used for rendering page content.

Front Matter Parsers - Extracts structured page-specific settings from document headers to manage metadata and rendering.

Bibliography Generators - Automatically compiles and formats BibTeX bibliographies and citations within documents.

Table of Contents - Generates clickable tables of contents and navigation lists to help users traverse site content.

Technical Documentation - Enables creation of structured manuals with mathematical notation, citations, and diagrams.

Custom Rendering Integrations - Modifies how markup formats are parsed and converted to HTML via custom libraries.

Content Management Search - Implements full-text search optimized for retrieving documents and articles across the repository.

Markup Extension Mappings - Maps file extensions to specific markup formats to determine how pages are rendered.

Academic Citations - Supports the insertion of academic citations and footnotes by referencing BibTeX identifiers.

Diagramming Engines - Integrates a rendering engine to visualize text-based descriptions as diagrams and charts via Mermaid.

Mathematical Typesetting - Renders mathematical formulas and technical notation into visually formatted equations for web display.

Equation Renderers - Displays complex mathematical expressions and formulas using specialized typesetting renderers.

Content Access Control Engines - Provides mechanisms to restrict or permit page editing based on global application settings.

Application Logic Hooks - Extends core behavior by redefining constants and registering custom hooks and filters.

Template Overrides - Enables replacing default layout components with user-defined template files to customize visual presentation.

Hook-Based Extension Frameworks - Implements a system for redefining constants and registering filters to modify core behavior.

Text-to-Diagram Generators - Converts structured text definitions into visual diagrams and sequence charts automatically.

Custom Language Handlers - Processes diverse page formats and macros using custom language handlers for specialized content rendering.

Interface Appearance Customizations - Allows modification of visual layout and behavior through custom styles, scripts, and template overrides.

Rich Text Renderers - Displays structured rich text including emojis, mathematical formulas, and annotations within pages.

Document Annotators - Allows users to suggest additions, deletions, and comments within the document editor.

Documentation - Host a Git-powered wiki with a web interface.

Documentation and Knowledge - Git-powered wiki system with a simple API.

General Utilities - Git-powered wiki with built-in Vim editing mode.

Wiki Platforms - Git-backed wiki system with a local frontend.

gollumgollum

Features

Star history