typemill / docs

The documentation for typemill. Feel free to improve!

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

1. Download and unpack the latest version of Typemill as a zip file from Typemill Website.
2. Upload all files to your server.
3. Visit your new website at www.your-typemill-website.com/tm/setup and create an admin user.
4. 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 [email protected], 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.

docs's Issues

The docs need more variety and specificity in function examples

The problem I've run into when trying to develop themes for Typemill is that I am very much not a programmer. Showing me how a Twig function or loop works with a single example isn't really enough for those of us who have a good handle on HTML/CSS and the like, but have trouble understanding anything more complicated than an if/else statement.

Take this example from the docs:

{% set pagelist = getPageList(navigation, settings.themes.emergency.listpages, base_url) %}
  <ol class="postlist" reversed>
    {% for element in pagelist.folderContent %}
      {% set post = getPageMeta(settings, element) %}
      {% set date = element.order[0:4] ~ '-' ~ element.order[4:2] ~ '-' ~ element.order[6:2] %}
      <li>
         <a href="{{ element.urlAbs }}">{{ post.meta.title }}</a> <time datetime="{{date}}">({{ date | date("d.m.Y") }})</time>
      </li>

    {% endfor %}
  </ol>

That tells me how to make it so I can set a folder in getPageList based on theme settings, and use it to display a folder's contents. But how would I set the folder manually, in the code itself? Is there some sort of page ID that needs to go where settings.themes.emergency.listpages is? How would I use this code to loop through all of my top-level folders to display their contents in a directory-style page?

Failing that, how would I add more details about each page or item to the navigation function, such as the meta description?

Simply put, we need more examples in the documentation, and I'm not smart enough to write them myself.