{"id":13510611,"url":"https://github.com/typemill/typemill","last_synced_at":"2025-05-15T15:05:34.777Z","repository":{"id":19852254,"uuid":"88095826","full_name":"typemill/typemill","owner":"typemill","description":"Typemill is a flat-file CMS based on Markdown and designed for informational websites like documentation, manuals, and handbooks.","archived":false,"fork":false,"pushed_at":"2025-03-18T14:28:59.000Z","size":23743,"stargazers_count":491,"open_issues_count":61,"forks_count":58,"subscribers_count":12,"default_branch":"v2.x","last_synced_at":"2025-03-31T20:05:28.130Z","etag":null,"topics":["cms","docs","documentation","documentation-tool","ebooks","epub-generation","flat-file","handbooks","helpauthoring","manuals","markdown","pdf-generation","publication","self-hosted","technical-writing","userguides","websites"],"latest_commit_sha":null,"homepage":"https://typemill.net","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/typemill.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":"https://www.paypal.me/typemill"}},"created_at":"2017-04-12T21:01:11.000Z","updated_at":"2025-03-23T12:16:41.000Z","dependencies_parsed_at":"2024-03-17T11:29:37.955Z","dependency_job_id":"2bf3f338-6dc8-48f1-8276-201e2dd4522d","html_url":"https://github.com/typemill/typemill","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typemill%2Ftypemill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typemill%2Ftypemill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typemill%2Ftypemill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typemill%2Ftypemill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typemill","download_url":"https://codeload.github.com/typemill/typemill/tar.gz/refs/heads/v2.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247730068,"owners_count":20986404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cms","docs","documentation","documentation-tool","ebooks","epub-generation","flat-file","handbooks","helpauthoring","manuals","markdown","pdf-generation","publication","self-hosted","technical-writing","userguides","websites"],"created_at":"2024-08-01T02:01:46.765Z","updated_at":"2025-05-15T15:05:34.770Z","avatar_url":"https://github.com/typemill.png","language":"JavaScript","funding_links":["https://www.paypal.me/typemill"],"categories":["PHP","JavaScript","websites","Apps","cms"],"sub_categories":["Writing"],"readme":"# Typemill\r\n\r\nTypemill is an open-source flat-file CMS for creating websites and eBooks with markdown files. It’s commonly used for informational websites such as user manuals, documentation, knowledge bases, wikis, and handbooks.\r\n\r\nLearn more at [typemill.net](https://typemill.net) or get started with the [starter guide](https://docs.typemill.net/getting-started).\r\n\r\n![Typemill Screenshot](/typemill.webp)\r\n\r\n## Key Features\r\n\r\n* **Flat-file** – no database required.  \r\n* **Modern stack** – built with Slim PHP, Vue.js, and Tailwind CSS.  \r\n* **Lightweight** – only 2MB when gzipped.  \r\n* **Author-friendly** – visual block editor and raw markdown editor.  \r\n* **Developer-friendly** – Twig templates, Symfony event dispatcher, YAML definitions.  \r\n* **Flexible** – extend with plugins, themes, and custom eBook layouts.  \r\n* **Single Source Publishing** – convert content to PDF and ePUB with the eBook plugin.\r\n\r\n## Requirements\r\n\r\nTo run Typemill, you need the following:\r\n\r\n* Web server (Apache or Nginx).\r\n* PHP 8.0 or higher.\r\n* Standard PHP libraries like mod_rewrite, gd, mbstring, fileinfo, session, iconv, and more.\r\n\r\n## Installation\r\n\r\nCheck installation guides for different setups at [docs.typemill.net](https://docs.typemill.net/getting-started/installation)\r\n\r\n### Using ZIP File and FTP\r\n\r\n1. Download and unpack the latest zip-version from the [Typemill Website](https://typemill.net).\r\n2. Upload all files to your server.\r\n3. Check the file-permissions (see below).\r\n4. Visit your new website at `www.your-typemill-website.com/tm/setup`.\r\n5. Create an admin user.\r\n6. Log in and start writing.\r\n\r\n### Using GitHub and Composer \r\n\r\nClone this repository:\r\n\r\n```\r\ngit clone https://github.com/typemill/typemill.git\r\n```\r\n\r\nRun Composer to install the required libraries:\r\n\r\n```\r\ncomposer update\r\n```\r\n\r\n### Using Docker\r\n\r\nUse the official image from [DockerHub](https://hub.docker.com/r/kixote/typemill) or read the description on [docs.typemill.net](https://docs.typemill.net/getting-started/installation/docker)\r\n\r\n## Folder Permissions\r\n\r\nEnsure that the following folders are writable:\r\n\r\n* `/cache`\r\n* `/content`\r\n* `/data`\r\n* `/media`\r\n* `/settings`\r\n\r\n## Security Issues\r\n\r\nIf you discover a potential security issue related to Typemill, please report it via email to security@typemill.net, and we'll address it promptly.\r\n\r\n## License\r\n\r\nTypemill is an open-source project published under the MIT License. Plugins, themes, and services are published under MIT and commercial licenses.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypemill%2Ftypemill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypemill%2Ftypemill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypemill%2Ftypemill/lists"}