Skip to content

Wiki-Go

docker builds binary builds version

Introduction

LeoMoon Wiki-Go is a modern, feature-rich, databaseless flat-file wiki platform built with Go. It provides a clean, intuitive interface for creating and managing knowledge bases, documentation, and collaborative content without requiring any external database.

No database. No bloat. Zero maintenance. Just Markdown.

Important Configuration Note with Non-SSL Setups

If you’re running Wiki-Go without SSL/HTTPS and experiencing login issues, you need to set allow_insecure_cookies: true in your config.yaml file and restart Wiki-Go. This is because:

  1. By default, Wiki-Go sets the “Secure” flag on cookies for security
  2. Browsers reject “Secure” cookies on non-HTTPS connections
  3. This prevents login from working properly on HTTP-only setups

Security Note: Only use this setting in development or in trusted internal networks. For public-facing wikis, always use HTTPS.

Features

Features at a Glance

  • ✍️ Full Markdown editing with emoji, Mermaid diagrams, and LaTeX math
  • 🔍 Smart full-text search with highlighting and advanced filters
  • 📁 Hierarchical page structure with version history
  • 👥 User management, access control, and private wiki mode
  • 🔗 Link management with automatic metadata fetching and categorization
  • 💬 Comments with moderation and markdown support
  • 📋 Interactive Kanban boards for project management
  • ⚡ Instant setup via Docker or prebuilt binaries
  • 🧩 Custom logos, banners, shortcodes, and more

Perfect for internal documentation, personal knowledge bases, team wikis, or project management.

Content Management

  • Markdown Support: Write content using Markdown syntax for rich formatting
  • Emoji Shortcodes: Use emoji shortcodes like :smile: in your Markdown content
  • File Attachments: Upload and manage images and documents (supports jpg, jpeg, png, gif, svg, txt, log, csv, sfd, zip, pdf, docx, xlsx, pptx, mp4)
  • Link Management: Create and organize collections of links with automatic metadata fetching for public HTTP(S) destinations, descriptions, and categorization. Metadata previews reject loopback, private-network, link-local, and cloud metadata destinations.
  • Hierarchical Organization: Organize content in nested directories
  • Version History: Track changes with full revision history and restore previous versions
  • Document Management: Create, edit, and delete documents with a user-friendly interface
  • Document Sorting and Naming: Control the order of documents in the sidebar through slug names:
    • Documents are sorted alphabetically by their directory slug name
    • Document titles (displayed in the sidebar and heading) are taken from the first H1 heading in document.md
    • To manually sort documents, prefix slug names with numbers (e.g., 1-overview, 2-installation, 3-usage)
    • The slug name can differ from the displayed title, allowing for organized structure while maintaining readable titles
    • Example: A directory named 1-getting-started with document.md containing # Getting Started Guide will show as “Getting Started Guide” in the sidebar but be sorted first

Collaboration & Feedback

  • Comments System: Enable discussions on documents with a full-featured commenting system
  • Markdown in Comments: Format comments using the same Markdown syntax as in documents
  • Comment Moderation: Administrators can delete inappropriate comments
  • Disable Comments: Option to disable comments system-wide through the wiki settings

Search & Navigation

  • Full-Text Search: Powerful search functionality with support for:
    • Exact phrase matching (using quotes)
    • Inclusion/exclusion of terms
    • Highlighted search results
  • Breadcrumb Navigation: Clear path visualization for easy navigation
  • Sidebar Navigation: Quick access to document hierarchy

User Experience

  • Responsive Design: Works on desktop and mobile devices
  • Dark/Light Theme: Toggle between dark and light modes
  • Code Syntax Highlighting: Support for multiple programming languages
  • Math Rendering: LaTeX math formula support via MathJax
  • Diagrams: Mermaid diagram integration for creating flowcharts, sequence diagrams, etc.

Administration

  • Access Rules: Path-based access control with public, private, and group-restricted visibility
  • User Groups: Assign users to one or more groups to grant access to restricted documents
  • User Management: Create and manage users with different permission levels (admin, editor, viewer)
  • Admin Panel: Configure wiki settings through a web interface
  • Statistics: Track document metrics and site usage

Advanced Features

  • Custom Shortcodes: Extend markdown with special shortcodes like :::stats recent=5::: for additional functionality
  • Media Embedding: Embed images, videos, and other media in your documents
  • Print Friendly: Optimized printing support for documentation
  • API Access: RESTful API for programmatic access to wiki content

Project Management

  • Interactive Kanban Boards: Transform any document into a visual project management board
  • Drag & Drop Tasks: Move tasks between columns with intuitive drag-and-drop functionality
  • Multiple Boards: Support for multiple kanban boards within a single document
  • Task Management: Create, edit, and organize tasks with full markdown formatting support
  • Real-time Updates: Changes are automatically saved and synchronized
  • Nested Tasks: Support for sub-tasks and hierarchical task organization

Demo Site

You can try out Wiki-Go using the live demo below. The demo site resets every hour, and all uploaded or edited content will be wiped automatically.

Customization

Custom Favicon

LeoMoon Wiki-Go comes with default favicons, but you can easily replace them with your own:

  1. To use custom favicons, place your files in the data/static/ directory with the following names:

    • favicon.ico - Standard favicon format (used by older browsers)
    • favicon.png - PNG format favicon
    • favicon.svg - SVG format favicon (recommended for best quality at all sizes)

  2. The application will automatically detect and use your custom favicon files without requiring a restart.

SVG format is recommended for favicons as it scales well to different sizes while maintaining crisp quality.

Custom Logo (Optional)

You can add a custom logo to display in the sidebar above your wiki title:

  1. Create a logo file in one of the supported formats:

    • logo.svg - SVG format (recommended for best quality)
    • logo.png - PNG format (alternative option)

  2. Place the logo file in the data/static/ directory.

  3. The logo will automatically appear in the sidebar above your wiki title.

Notes:

  • The logo is displayed at 120×120 pixels, but will maintain its aspect ratio
  • SVG format is recommended for the best appearance at all screen sizes
  • No configuration changes or application restart needed
  • If no logo file is present, only the wiki title will be displayed
  • If both logo.svg and logo.png exist, logo.svg will be used

Global Banner (Optional)

You can add a banner image that will appear at the top of all documents:

  1. Create a banner image in one of the supported formats:

    • banner.png - PNG format (recommended for best quality)
    • banner.jpg - JPG format (alternative option)

  2. Place the banner file in the data/static/ directory.

  3. The banner will automatically appear at the top of all document content.

Notes:

  • The banner is displayed with responsive width and a maximum height of 250px
  • The banner maintains its aspect ratio while fitting different screen sizes
  • No configuration changes or application restart needed
  • To remove the banner, simply delete the file from the data/static/ directory
  • If both banner.png and banner.jpg exist, banner.png will be used

User Management

LeoMoon Wiki-Go includes a user management system with different permission levels:

  • Admin users: Can create, edit, and delete content, manage users, and change settings
  • Editor users: Can create, edit, and delete content
  • Regular users: Can view content (useful when in private mode)

The default admin credentials are:

  • Username: admin
  • Password: admin

It’s recommended to change these credentials immediately after first login.

Security

  • Authentication: User authentication with secure password hashing
  • Role-Based Access: Three user roles (admin, editor, viewer) with different permission levels
  • Access Rules: Path-based document access control with public, private, and group-restricted options
  • User Groups: Assign users to groups for fine-grained access to restricted content
  • Login Rate Limiting: Protection against brute force attacks with temporary IP bans after multiple failed attempts
  • Private Mode: Optional private wiki mode requiring login
  • Admin Controls: Separate admin privileges for content management

For detailed security documentation, see SECURITY.md .

Usage

Creating Content

  1. Log in with admin credentials
  2. Use the “New” button to create a new document
  3. Write content using Markdown syntax
  4. Save your document

Organizing Content

LeoMoon Wiki-Go allows you to organize content in a hierarchical structure:

  1. Create directories to group related documents
  2. Use the move/rename feature to reorganize content when in edit mode
  3. Navigate through your content using the sidebar or breadcrumbs

Attaching Files

You can attach files to any document:

  1. Navigate to the document and enter edit mode
  2. Click the “Attachments”
  3. Upload files using the upload button
  4. Use “Files” tab to insert links to files in your document

Using Comments

The commenting system allows users to provide feedback and engage in discussions:

  1. Navigate to any document
  2. Scroll to the comments section at the bottom
  3. Authenticated users can add comments using Markdown syntax
  4. Administrators can delete any comments
  5. Comments can be disabled system-wide through the admin settings panel

Importing from Notion

If you are migrating from Notion, a community-provided Python script is available to help import your Notion markdown export directly into Wiki-Go’s document tree. It automatically converts page hierarchies and handles file attachments.

For detailed instructions, see the Notion Import Tool Documentation .

Shortcuts

Wiki-Go provides several keyboard shortcuts to enhance productivity:

General Shortcuts

  • Ctrl+E - Enter edit mode
  • Ctrl+S - Save document when in edit mode
  • Ctrl+Shift+F - Focus the search box
  • Escape - Exit edit mode or close dialogs

Formatting Shortcuts (in edit mode)

  • Ctrl+B - Toggle bold formatting
  • Ctrl+I - Toggle italic formatting
  • Ctrl+H - Toggle/cycle heading levels (# -> ## -> ### … -> plain text)
  • Ctrl+K - Toggle block quote
  • Ctrl+/ - Toggle code formatting (inline code for single-line selections, code blocks for multi-line selections or current line when nothing is selected)
  • Ctrl+Shift+P - Preview Toggle
  • Alt+Z - Toggle word wrap
  • Alt+N - Toggle line numbers
  • Alt+C - Toggle auto-capitalize

Table Editing

Wiki-Go includes powerful table editing capabilities with keyboard shortcuts:

  • Tab - Move to next cell (creates a new column when in the last cell of a row)
  • Shift+Tab - Move to previous cell
  • Enter - Move to cell below / create new row
  • Ctrl+Enter - Exit table at current position

Arrow Key Navigation

  • Ctrl+Left - Move to cell on the left
  • Ctrl+Right - Move to cell on the right
  • Ctrl+Up - Move to cell above
  • Ctrl+Down - Move to cell below

Column/Row Alignment

  • Ctrl+Shift+Left - Align column left
  • Ctrl+Shift+Right - Align column right
  • Ctrl+Shift+Up - Align column center
  • Ctrl+Shift+Down - Remove column alignment

Moving Columns/Rows

  • Alt+Up - Move row up
  • Alt+Down - Move row down
  • Alt+Left - Move column left
  • Alt+Right - Move column right

Technical Details

Built With

Architecture

  • Simple Configuration: Easy YAML-based configuration
  • File-Based Storage: Documents stored as Markdown files
  • Lightweight & Fast: Built for performance
  • No External Database: Self-contained with file-based storage

Folder Structure

Wiki-Go uses a simple flat-file structure to store all content:

data/
├── config.yaml                   # Main configuration file for Wiki-Go
├── documents/                    # Regular wiki documents
│   └── path/
│       └── to/
│           └── doc-name/         # Document directory named "doc-name"
│               └── document.md   # The actual markdown content for "doc-name"
│
├── versions/                     # Version history storage
│    ├── documents/               # Regular document versions
│    │   └── path/
│    │       └── to/
│    │           └── doc-name/    # Timestamped version backup
│    │               └── YYYYMMDDhhmmss.md
│    └── pages/                   # Special pages versions
│        └── home/                # Timestamped homepage backup
│            └── YYYYMMDDhhmmss.md
│
├── pages/                        # Special pages (system pages)
│   └── home/                     # Homepage (landing page)
│       └── document.md           # Homepage content
│
├── comments/                     # Document comments
│   └── path/
│       └── to/
│           └── doc-name/         # Timestamped comments for "doc-name"
│               └── YYYYMMDDhhmmss_[user].md
│
└── static/                       # Static assets and customization
    ├── banner.png                # Global banner on all pages (optional, preferred)
    ├── banner.jpg                # Global banner on all pages (optional)
    ├── favicon.ico               # Standard favicon (optional)
    ├── favicon.svg               # SVG format favicon (optional, preferred)
    ├── favicon.png               # PNG format favicon (optional)
    └── langs/                    # Translation files copied by wiki-go at startup

The flat-file structure makes it easy to back up, version control, or manipulate wiki content outside the application if needed. All content is stored as plain Markdown files, and version history follows a simple timestamped file naming convention. File attachments are stored alongside the document.md file in the same directory, making it straightforward to manage document content and its associated files together.

LeoMoon Wiki-Go is designed to be simple to deploy and use while providing powerful features for knowledge management. It’s perfect for team documentation, personal knowledge bases, and collaborative projects.