Welcome¶
Simple-Wiki is a personal markdown wiki — wiki links, search, uploads, revision history, templates, and an admin dashboard. Most people run it on a home network or NAS.
The home page with sidebar table of contents and a built-in syntax cheat sheet.
This guide covers using the wiki. For installation, Docker, and server settings, see the project README.
What you can do¶
| Role | Capabilities |
|---|---|
| Visitor | Read, search, tweak reading settings (when public read is on) |
| Editor | Create and edit pages, upload files, view history, restore revisions, use extensions |
| Admin | All of the above, plus users, backups, extensions, and revision limits |
Every account can edit
There are no read-only editors. Only create accounts for people you trust.
Where to start¶
- New to the wiki? First login then Navigation
- Want to write? Editing basics
- Running the wiki? Admin dashboard
Built-in help¶
Your wiki also has a help article at /wiki/help. Open it from the gear icon → Help, or visit that URL directly.