mirror/php-typemill
1
0
Fork 0
mirror of https://github.com/typemill/typemill.git synced 2025-08-01 03:40:27 +02:00
Code Issues Releases Wiki Activity

Version 1.2.7: Reorder Content Blocks

Browse Source
This commit is contained in:
Sebastian
2018-11-10 14:29:56 +01:00
parent 2633ab69be
commit d87fe9d0d9
14 changed files with 61 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
readme.md
View File

@@ -1,8 +1,8 @@
# About TYPEMILL
TYPEMILL is a small flat file cms designed for writers. It creates websites based on markdown files and can be used for manuals, documentations, web-books and similar publications. The website http://typemill.net itself is an example-website for TYPEMILL.
TYPEMILL is a small flat file cms created for editors and writers. It generates websites based on markdown files and can be used for manuals, documentations, web-books and similar publications. The website http://typemill.net itself is an example-website for TYPEMILL.
![TYPEMILL Screenshot](/themes/typemill/typemill.jpg)
![TYPEMILL Screenshot](https://typemill.net/media/demo-2.gif)
## Features
@@ -15,13 +15,22 @@ TYPEMILL is a small flat file cms designed for writers. It creates websites base
* Supports configurable themes and plugins.
* Provides an author panel to configure the system, the themes and the plugins.
* Creates and manages users.
* Provides a basic online editing (only for existing files so far, in development).
* Provides a pure markdown editor.
* Provides a visual markdown editing mode (experimental).
* Markdown supports table of contents (TOC), tables, footnotes, abbreviations and definition lists.
* Supports MathJax and KaTeX (plugin).
* Supports code highlighting (plugin).
* Supports Matomo/Piwik and Google Analytics (plugin).
* Supports Cookie Consent (plugin).
## Requirements
* PHP 7+
* Apache server
* mod_rewrite and htaccess
If you run a linux system, then please double check that mod_rewrite and htaccess are active!!!
## Installation
Download TYPEMILL from the [TYPEMILL website](http://typemill.net), unzip the files and you are done.
@@ -33,6 +42,7 @@ If you are a developer, you can also clone this repository. To do so, open your
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](http://getcomposer.org) and start to learn.
To run TYPEMILL on a **live** system, simply upload the files to your server.
@@ -45,10 +55,6 @@ Please go to `your-typemill-website.com/setup`, create an initial user and then
You can find your login screen under `/tm/login` or simply go to `/setup` and you will be redirected to the login-page.
## Requirements
Your server should run with PHP 5.6 or newer. No database is required.
## Documentation
You can read the full documentation for writers, for theme developers and for plugin developers on the [TYPEMILL website](http://typemill.net).