Fox Wiki
Last updated: September 28, 2025
FoxWiki is a flexible, modern, and secure documentation system with hybrid rendering capabilities that allows you to create
beautiful, fast, and responsive documentation sites.
FoxWiki is currently in an Alpha stage and subject to changes!
Why is FoxWiki?
FoxWiki, born as an OrangeFox side project but open to all, was created to address a gap in existing documentation solutions.
While there are many wiki engines available, few combine an attractive interface, easy usage, and the ability to serve new content right after updating
the source directory.
Existing solutions often needed complicated setup, had outdated designs, or required manual steps
to show content updates.
FoxWiki fixes these problems by offering a sleek, less distracting, straightforward interface.
Key Features
- Easy to host: The basic setup required just a container with an exposed port and a mounted documentation directory.
- Modern: Built with Next.js and Material UI (Joy UI)
- Responsive: Works great on all devices
- Hybrid Rendering: Server-side and client-side rendering for optimal performance
- Auto refresh: Automatically updates content for users when a file is modified / updated
- Table of Contents: Automatically generated from your content and anchor links
Dual Data Sources: Choose between local Markdown files or a remote API- Responsive Design: Optimized for all screen sizes
- Dark / Light Mode: Built-in theme switching
- Markdown Support: Full support for GitHub-flavored Markdown
- Easy migration from Wiki.js: Support for most Wiki.js Markdown syntax and features
- Code Highlighting: Syntax highlighting for code blocks
- Customizable Branding: Easy to customize with your own branding, including color scheme
- Containers Support: Easy deployment with Podman / Docker
- Security First: Requires read-only Markdown directory access, never modifies source files, advices a SELinux enabled containerization environment
1-minute quickstart using Podman
For more information, please check the appropriate page
Manual Installation (development)
-
Clone the repository:git clone https://gitlab.com/OrangeFox/infrastructure/foxbox.git
-
Install dependencies:yarn install
-
Run the development server:yarn dev
-
Build for production:yarn build
License
FoxWiki is open-source software licensed under the aGPLv3 license.
Feel free to use and modify, but please share any modifications you make.