Just a databaseless markdown flat-file wiki
Wiki|Docs is a privacy-friendly wiki for people who want to own their knowledge base.
Run it entirely on your computer with the standalone desktop app, or host it yourself with Docker. Your content remains portable Markdown files, rather than data locked into a database or cloud service.
Project homepage: https://www.wikidocs.app
Please consider supporting this project by making a donation via PayPal.
Wiki|Docs 2 is a complete rewrite in TypeScript across the entire stack: the NestJS backend, Angular web client, and Electron desktop application.
The new architecture brings:
- A standalone desktop application that keeps your Markdown files on your computer, ready for use with the LLM tools you choose.
- A self-hosted Docker service that can remotely store and serve the same portable data (privately or publicly).
- Desktop and remote sync, so you can work locally and keep your knowledge base updated with your self-hosted instance.
- REST APIs that make Wiki|Docs straightforward to integrate with other tools and workflows.
If you are looking for the original PHP version of the project, please see this branch.
Wiki|Docs is designed for people who value ownership over their information. It keeps the writing experience simple while giving you the freedom to work locally, self-host when needed, and move your content without vendor lock in.
| What you need | What Wiki|Docs provides |
|---|---|
| Privacy and portability | Plain Markdown files and no database required. |
| A simple local workspace | A standalone desktop app that works without a hosted service. |
| Access from anywhere | Optional Docker self-hosting and sync between the desktop app and a remote instance. |
- Try the public demo to explore Wiki|Docs immediately.
- Download the desktop application to keep your wiki entirely local.
- Run the Docker image when you want a self-hosted instance or remote sync.
Wiki|Docs combines the convenience of a modern editor with the durability of plain text Markdown. Whether you are documenting a project, building a personal knowledge base, or sharing a team wiki, the same portable files remain at the center of your workflow.
- Open source
- Plain text files
- No database required
- Markdown syntax
- YAML Frontmatter
- Editor full WYSIWYG
- Support for KaTeX math
- Support for Mermaid diagrams
- Unlimited page revisions
- Uploading and downloading attachments
- Uploading images (also from clipboard)
- Content can be categorized in namespaces
- Public and private browsing
- Desktop and remote sync
- Syntax highlighting
- Multiple languages
- Dark mode
- And much more.
Explore the demo playground at http://demo.wikidocs.app with the following demo credentials:
Authentication:
Username: john.doe@wikidocs.app
Password: wikidocs
If Wiki|Docs is useful to you, please consider starring the project.
Here is a glimpse of the desktop and web experience. Select any image to open the original screenshot at full size.
To run Wiki|Docs, you can either use the desktop application or run it in a self-hosted environment.
Download the latest desktop application release and run the installer.
The application will be installed on your system, then you can launch it from the Start menu or desktop shortcut.
A Docker image is available on Docker Hub to run Wiki|Docs in a container.
Running Wiki|Docs in a container is the recommended way to host it yourself, as it is the easiest and fastest way to get started.
Once the container is running, open the web client at http://localhost:3210. The backend API and Swagger documentation are available at http://localhost:3210/api/.
docker run -p 3210:3210 zavy86/wikidocs:2
docker run --name wikidocs -d -p 3210:3210 -v /path/to/local/wikidocs/datasets/or/volume:/var/lib/wikidocs zavy86/wikidocs:2
Use the following docker-compose.yml file to run Wiki|Docs with Docker Compose.
volumes:
datasets:
services:
wikidocs:
image: zavy86/wikidocs:2
environment:
MODE: public|private
SECRET: generate-a-secret-key-here
volumes:
- datasets:/var/lib/wikidocs/datasets
ports:
- "3210:3210"
To sync your Wiki|Docs data across multiple devices, host the application yourself and configure the desktop app to connect to your remote instance.
Open the Settings menu from the File menu (press Alt on Windows) to enter the sync configuration.
You can then access and edit your Wiki|Docs content online from any device.
Before migrating from version 1.x.x (legacy), always create a complete backup of your dataset.
Despite the significant structural changes in this release, your data remains fully compatible. On first launch, reconfigure the wiki and create an administrator user. All existing documents will then work as expected.
The only manual adjustment is to move the homepage document to the root directory, because version 2 no longer uses the legacy homepage slug as its index page.
If you use Docker, point to port 3210 instead of 80 and bind the dataset volume to /var/lib/wikidocs/datasets.
Start with the resources below to learn how to use, host, extend, or get help with Wiki|Docs.
- Visit www.wikidocs.app for product documentation and guides.
- Open your self-hosted instance at
/api/for the Swagger documentation. - Ask questions or share ideas in GitHub Discussions.
- Report a problem through GitHub Issues.
Contributions of every kind are welcome, from bug reports and feature ideas to documentation, testing, code, and pull request reviews.
- Report a bug
- Propose a feature
- Improve the documentation
- See where help is wanted
- Find a good first issue
- Contribute code
This section recognizes the people who have helped make this project possible.
If you want to contribute to the project, please check the CONTRIBUTING file for more information.
💡 Manuel Zavatta ( Website | LinkedIn | YouTube | Contacts )
- Alex Meyer
- Micha
- Bo Allen
- Joel Vega
- Sam
- kevwkev
- Сергей Ворон
- Nicolas Prenveille
- Antonio Rodrigues
- Miguel Renato
- Alain Martini
- Davide Visentin
- Christian Weber
- Petr Husák
- Oliver Lehmann
- Prabal Khare
- Roberto Bellingeri
This project is licensed under the MIT License.