wikit

module
v0.0.0-...-3898052 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License: MIT

README

Wikit

wikit.firelizard.com

A simple wiki tool designed for pure client-side operation. Wikit runs entirely in the browser as a single-page application, authenticating via OAuth and committing changes directly to GitLab repositories.

Features

  • Pure client-side - No server required, runs entirely in your browser.
  • No build step for UI - Frontend uses pure JavaScript with no transpilation or bundling.
  • GitLab integration - Authenticate with OAuth and store wiki content in GitLab repositories.
  • Markdown editing - Built on Monaco editor with full markdown support.
  • Offline capable - IndexedDB caching for working without network access.
  • Go WASM backend - Core logic written in Go, compiled to WebAssembly.

Documentation

  • Getting Started - Installation, configuration, and quick start guide
  • Using Wikit - Writing content, managing files, and committing changes
  • Architecture - Design overview, frontend/backend split, and storage implementation
  • Development Guide - Building from source, project structure, and contributing
  • Reference - API documentation, configuration options, and browser compatibility

Architecture

Wikit uses a split architecture: a pure JavaScript frontend handles the UI and user interactions, while a Go WASM backend runs as a web worker to manage data operations and GitLab API communication.

Wikit is structured to support multiple backend providers, though currently only GitLab is implemented.

Directories

Path Synopsis
cmd
wikit command
pkg
fs

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL