|
|
||
|---|---|---|
| cache | ||
| content | ||
| cypress | ||
| data/security | ||
| docker-utils | ||
| media | ||
| plugins | ||
| settings | ||
| system | ||
| themes/cyanine | ||
| .dockerignore | ||
| .gitignore | ||
| .htaccess | ||
| composer.json | ||
| composer.lock | ||
| cypress.json | ||
| Dockerfile | ||
| index.php | ||
| licence.md | ||
| package-lock.json | ||
| package.json | ||
| readme.md | ||
| tailwind.config.js | ||
| typemill.png | ||
Typemill: A Flat File CMS for Publishers
Typemill is a lightweight, flat-file CMS designed for simple, fast, and flexible website and eBook creation using Markdown.
With a focus on content and text, it perfectly fits use cases such as documentations, manuals, and other text-heavy websites.
Key Features (Selection)
- No database required (flat-file approach).
- High performance, with a modern tech stack including Vue.js, Tailwind CSS, and Slim PHP.
- Lightweight, with a gzip size of about 2MB.
- Markdown editing with a visual block editor or a raw markdown editor.
- Easy extendible with plugins, themes, and page-tabs.
- Generation of ebooks (pdf, epub) with an ebook-plugin.
- Flexible form-generation.
- API-architecture and headless mode.
Resources
- Download and Documentation: Typemill Website
- Plugins: Typemill Plugins
- Themes: Typemill Themes
- Book Layouts: Typemill Book Layouts
- Issues and Bug Reports: GitHub Issues
- Discussions: GitHub Discussions
- Newsletter: Typemill Newsletter
Requirements
To run Typemill, you need the following:
- Web server (Apache, not tested on other servers).
- PHP 8.0 or higher.
- Standard PHP libraries like mod_rewrite, gd-image, mbstring, fileinfo, session, iconv, and more.
Installation
Check installations with different setups on typemill.net
Using ZIP File and FTP
- Download and unpack the latest version of Typemill as a zip file from Typemill Website.
- Upload all files to your server.
- Visit your new website at
www.your-typemill-website.com/tm/setupand create an admin user. - Log in and start publishing.
Using GitHub and Composer
Clone this repository:
git clone https://github.com/typemill/typemill.git
Then update composer to load the libraries:
composer update
Using Docker
See description on typemill.net
Folder Permissions
Ensure that the following folders are writable:
/cache/content/data/media/settings
Tech Stack
- PHP (Slim Framework Version 4)
- JavaScript (Vue.js Version 3)
- CSS (Tailwind)
Security Issues
If you discover a potential security issue related to Typemill, please report it via email to security@typemill.net, and we'll address it promptly.
License
Typemill is an open-source project published under the MIT License. Plugins, themes, and services are published under MIT and commercial licenses.