About this project

Konawiki3 is a lightweight, self-hosted Wiki designed for authoring manuscripts, creating manuals, and sharing information. Its core design principle is that all Wiki content is stored as plain text files, which allows users to track changes with Git and manage documents with a simple, text-based workflow. The main developer has used Konawiki to write dozens of technical books, highlighting its utility as a writing and documentation tool. It can serve as an alternative to a traditional text editor for managing structured documents. The system supports two markup languages: standard Markdown and its original KonaNotation. Users can choose their preferred markup style globally through the configuration, or on a per-page basis using file extensions (e.g., `.md` for Markdown, `.txt` for KonaNotation). This flexibility accommodates different user preferences and workflow requirements. Konawiki3 includes a file-based tag system for organizing pages. Users can add `#tag(TagName)` to a page to classify it and use `#tags(TagName)` to display a list of all pages with a specific tag. Site configuration, including appearance, user management, and plugin enablement, is handled through a web-based admin page, eliminating the need for direct configuration file editing. Installation requires a web server capable of running PHP. It can be deployed by cloning the repository, uploading a release zip file, or running it locally using Docker Compose. Optional features, such as Git saving and simple PDF generation, can be enabled by installing libraries via Composer. The system also includes AI writing assistance features—such as text summarization, proofreading, sentence rephrasing, and automatic continuation—which can be enabled by configuring a ChatGPT API key. A plugin system is also included to extend its functionality.