Typemill
About this project
TYPEMILL is a lightweight flat file cms for micro-publishers. You can use it for documentations, manuals, special interest websites, and any other information-driven web-project. You can also enhance Typemill with plugins and generate professional e-books in pdf-format with it. The website http://typemill.net runs with Typemill.
Typemill V2
This is the repository of Typemill V1. Typemill is compatible with PHP 7.4 and PHP 8.0.
We are working on a version 2 that will run with PHP 8.0 and higher. Alpha-release is planned for July 2023.
Join the newsletter to get updates and check the branch tm2-dev if you want to help and contribute.
Features
- Website with markdown-files.
- Visual markdown editor (VUE.js) and raw markdown mode.
- Flexible drag & drop navigation.
- Markdown extras with table of contents (TOC), tables, footnotes, abbreviations, definition lists, notices, figures with captions
- Media library with images and files.
- System configurations.
- User management.
- Flexible form management with YAML-files.
- Flexible access rights.
- Themes (with TWIG).
- Plugins (with symfony event dispatcher).
Requirements
- PHP 7.4 or PHP 8.0 (Typemill V1 does NOT run with PHP 8.1)
- Apache server
- mod_rewrite and htaccess
If you run a linux system, then please double check that mod_rewrite and htaccess are active!!!
Installation
ZIP-Version
Download TYPEMILL from the TYPEMILL website, unzip the files and you are done.
The zipped version has a minimal size without developer files.
GitHub + Composer
If you are a developer, you can clone this repository. To do so, open your command line, go to your project folder (e.g. htdocs
) and type:
git clone git://github.com/typemill/typemill.git
The GitHub-version has no vendor-folder, so you have to update and include all libraries and dependencies with composer. To do so, open your command line, go to your TYPEMILL folder and type:
composer update
If you did not use composer before, please go to the composer website and start to learn.
Run Live
To run TYPEMILL on a live system, simply upload the files to your server.
Make Folders Writable.
Make sure that the following folders and all their files are writable (permission 774
recursively):
cache
content
media
settings
You can use your ftp-software for that.
Setup
If you visit your website first, then you will be redirected to the /setup
page. Please create an initial user and configure your system in the author panel.
Login
You can find your login screen under /tm/login
or simply go to /setup
and you wi