A documentation site generator that turns Markdown files into a website with no build step required.
31.6K+6 this week5.8KJavaScriptMITWell maintainedUpdated yesterday
typemill/typemill
A flat-file CMS that builds informational websites and eBooks from Markdown files, with no database required.
- Stars
- 620
- Forks
- 75
- Open issues
- 53
- Last commit
- 2 days ago
What is it?
Typemill is a self-hosted, flat-file content management system that stores pages as Markdown files instead of in a database. It is aimed at informational sites such as user manuals, product documentation, knowledge bases, wikis and handbooks.
Authors can write in a visual block editor or a raw Markdown editor. The stack is built on Slim PHP, Vue.js and Tailwind CSS, and templates use Twig with YAML definitions. Plugins, themes and custom eBook layouts extend the system.
The eBook plugin converts the same content into PDF and ePUB, so one set of Markdown sources can serve both web and print or e-reader formats. It requires PHP 8.1 or higher and a web server such as Apache or Nginx, and can be installed via ZIP upload, Composer or Docker.
Key features
- 01Flat-file storage with no database required
- 02Visual block editor and raw Markdown editor
- 03Export content to PDF and ePUB via the eBook plugin
- 04Extensible through plugins, themes and custom eBook layouts
- 05Twig templates and YAML definitions for developers
Use cases
- Publishing a product user manual or technical documentation site
- Building an internal handbook or knowledge base maintained in Markdown
- Producing both a website and an eBook from the same source files
Quick start
- 1
Clone the repository from GitHub
git clone https://github.com/typemill/typemill.git - 2
Install the required PHP libraries with Composer
composer update
Things to know
- Requires a web server (Apache or Nginx) and PHP 8.1 or higher.
In collections
Topics
FAQ
- What is typemill?
- A flat-file CMS that builds informational websites and eBooks from Markdown files, with no database required. Typemill is a self-hosted, flat-file content management system that stores pages as Markdown files instead of in a database. It is aimed at informational sites such as user manuals, product documentation, knowledge bases, wikis and handbooks.
- Is typemill free to use? What license does it have?
- typemill is open source under the MIT license. Check the license terms before using it in commercial products.
- Is typemill still maintained?
- Actively maintained. The last commit to typemill was on Nov 5, 2026.
- What can I use typemill for?
- Publishing a product user manual or technical documentation site Building an internal handbook or knowledge base maintained in Markdown Producing both a website and an eBook from the same source files
- How do I install typemill?
- Clone the repository from GitHub: git clone https://github.com/typemill/typemill.git Install the required PHP libraries with Composer: composer update
- Where can I get typemill?
- The source code and installation instructions are on GitHub: https://github.com/typemill/typemill
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
Python documentation generator that builds HTML, PDF, EPUB and other output from reStructuredText or Markdown sources.
8.1K2.6KPythonOtherUpdated 5 days ago
A flat-file CMS for building websites and blogs that stores content as JSON, so no database is needed.
1.5K+1 this week340PHPMITWell maintainedUpdated yesterday
A lightweight, flat-file wiki-style CMS for artists and experimental web projects, usable without JavaScript.
578PHPAGPL-3.0Well maintainedUpdated 11 days ago
A databaseless, self-hosted wiki that stores pages as portable Markdown files, with a desktop app and Docker deployment.
53364TypeScriptMITWell maintainedUpdated 13 days ago
Self-hosted wiki that runs as a single Go binary with SQLite and Markdown files on disk, no external database needed.
1.2K+13 this week102GoMITWell maintainedUpdated 11 hours ago