Repolode
Zavy86

Zavy86/WikiDocs

A databaseless, self-hosted wiki that stores pages as portable Markdown files, with a desktop app and Docker deployment.

Open-source alternative to:NotionConfluence

Stars
533
Forks
64
Open issues
13
Last commit
13 days ago

What is it?

Wiki|Docs is a wiki for people who want to keep their knowledge base as plain Markdown files rather than in a database or cloud service. It can run entirely on your computer as a standalone desktop app, or be hosted yourself with Docker and accessed through a web client.

Pages are written in a WYSIWYG editor with Markdown syntax, YAML frontmatter, KaTeX math and Mermaid diagrams. The wiki keeps unlimited page revisions, supports attachments and clipboard image uploads, organizes content into namespaces, and offers public and private browsing. Desktop and remote sync lets you edit locally and push changes to a self-hosted instance.

The project provides REST APIs with a Swagger document page, so other tools can read and write content. The stack is TypeScript across the NestJS backend, Angular client and Electron desktop app.

Key features

  • 01Stores pages as plain Markdown files with no database required
  • 02WYSIWYG editor with KaTeX math and Mermaid diagram support
  • 03Unlimited page revisions with version history
  • 04Desktop app and Docker self-hosting with desktop-to-remote sync
  • 05REST API with Swagger documentation
  • 06Attachments, clipboard image uploads, and namespace-based organization

Use cases

  • Keeping a personal knowledge base on your own computer
  • Hosting a team or project wiki on your own server
  • Storing documentation as Markdown files that can be used with LLM tools
  • Publishing a public wiki while keeping the content portable

Quick start

  1. 1

    Try the public demo in your browser

  2. 2

    Download and run the desktop application from the releases page

  3. 3

    Run the Docker image for a self-hosted instance

    docker run -p 3210:3210 zavy86/wikidocs:2

Things to know

  • Upgrading from version 1.x requires a manual step to move the homepage document to the root directory.
  • Syncing across devices requires you to host a remote instance yourself.

In collections

Topics

FAQ

What is WikiDocs?
A databaseless, self-hosted wiki that stores pages as portable Markdown files, with a desktop app and Docker deployment. Wiki|Docs is a wiki for people who want to keep their knowledge base as plain Markdown files rather than in a database or cloud service. It can run entirely on your computer as a standalone desktop app, or be hosted yourself with Docker and accessed through a web client.
Is WikiDocs free to use? What license does it have?
WikiDocs is open source under the MIT license. Check the license terms before using it in commercial products.
Is WikiDocs still maintained?
Actively maintained. The last commit to WikiDocs was on Oct 25, 2026.
What can I use WikiDocs for?
Keeping a personal knowledge base on your own computer Hosting a team or project wiki on your own server Storing documentation as Markdown files that can be used with LLM tools Publishing a public wiki while keeping the content portable
How do I install WikiDocs?
Try the public demo in your browser Download and run the desktop application from the releases page Run the Docker image for a self-hosted instance: docker run -p 3210:3210 zavy86/wikidocs:2
Where can I get WikiDocs?
The source code and installation instructions are on GitHub: https://github.com/Zavy86/WikiDocs

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects