mecha-cms/mecha

Mecha is a file-based CMS that survives on the principle that a database–less site should be personal, portable, light and easy to be exported and backed up. That’s why most of the projects associated with Mecha are created with personal natures and are dedicated to be used for personal purposes such as blog, journal and diary.

Mecha CMS

Mecha is a flat-file content management system for minimalists., _(*1)

, _(*2)

, _(*3)

, _(*4)

Front-End

The [default layout][mecha-cms/y.log] uses only Serif and Mono fonts. Different operating systems may produce slightly different results. This preview was taken from a computer running [Arch Linux][taufik-nurrohman/arch] operating system. The Serif font shown in the preview should be [DejaVu Serif][dejavu-serif]:, _(*5)

, _(*6)

Back-End ([Optional][mecha-cms/x.panel])

To be able to activate the back-end feature requires you to install our [Alert][mecha-cms/x.alert], [Panel][mecha-cms/x.panel], and [User][mecha-cms/x.user] extensions. This feature is forever optional. You can use this feature on the local version only, and remove it on the public version to secure your website (only if you don’t trust this extension)., _(*7)

, _(*8)

Colors and font types in the control panel preview above are generated from the [default skin][mecha-cms/x.panel.skin.default]. Without them, the display will look like the preview below:, _(*9)

, _(*10)

Features

• Writing pages with ease using [Markdown][mecha-cms/x.markdown] extension.
• Unlimited page children.
• Unlimited page fields.
• Extensible as hell.
• Create unique design for each blog post by adding special CSS and JavaScript files using [Art][mecha-cms/x.art] extension.
• Built-in commenting system using [Comment][mecha-cms/x.comment] extension.
• RSS and Sitemap using the [Feed][mecha-cms/x.feed] and [Sitemap][mecha-cms/x.sitemap] extension.
• Easy to use and well documented API.
• Almost everything are optional.
• Control panel using [Panel][mecha-cms/x.panel] extension.

Requirements

• Apache 2.4 and above, with enabled [mod_rewrite][apache/mod_rewrite] module.
• PHP 7.3 and above.

Preparations

1. Make sure that you already have the required components.
2. Download the available package from the [home page][home].
3. Upload Mecha through your FTP/SFTP to the public folder/directory on your site, then extract it!
4. Take a look on the available extensions and layouts that you might be interested.
5. Upload your extension files to .\lot\x and your layout files to .\lot\y. They’re auto-loaded.
6. Read on how to add pages and tags. Learn on how to create pages from the author by looking at the [source code][mecha-cms/site].
7. Install [Panel][mecha-cms/x.panel] extension if you are stuck by doing everything manually. You always have the full control to remove this extension without having to worry that your site will stop running after doing so.

Alternatives

Command Line

This assumes that your site’s public directory is in /srv/http. Make sure the folder is empty, or move the existing files to another place first. Don’t forget with that . at the end of the command as written in the example below, to clone the repository into the current root folder., _(*11)

Using Composer

~~~ .sh cd /srv/http composer create-project mecha-cms/mecha ., _(*12)

You may want to install our [Panel][mecha-cms/x.panel] extension as well:

~~~ .sh
composer require mecha-cms/x.panel

Using Git

~~~ .sh cd /srv/http git clone https://github.com/mecha-cms/mecha.git --depth 1 . git submodule update --init --recursive, _(*13)

You may want to install our [Panel][mecha-cms/x.panel] extension as well. Here, [Alert][mecha-cms/x.alert], and
[User][mecha-cms/x.user] extension is required to be installed:

~~~ .sh
git submodule add https://github.com/mecha-cms/x.alert.git --depth 1 lot/x/alert
git submodule add https://github.com/mecha-cms/x.user.git --depth 1 lot/x/user
git submodule add https://github.com/mecha-cms/x.panel.git --depth 1 lot/x/panel

Web Browser

Download the installer file from https://github.com/mecha-cms/start and then follow the instructions., _(*14)

Contributors

This project exists and survives because of you. I would like to thank all those who have taken the time to contribute to this project., _(*15)

, _(*16)

Contribute financially to keep the project domain and website accessible to everyone. The website provides complete documentation and latest information regarding the software and future development plans. Some parts of the website also serve to provide a clean and efficient project file download feature which is obtained by managing responses from the GitHub API., _(*17)

Backers

, _(*18)

Sponsors

, _(*19)

[apache/mod_rewrite]: http://httpd.apache.org/docs/current/mod/mod_rewrite.html 'Apache Module mod_rewrite' [dejavu-serif]: https://commons.wikimedia.org/wiki/File:DejaVuSerifSpecimen.svg 'DejaVu Serif · Wikimedia Commons' [home]: https://mecha-cms.com 'Mecha CMS' [mecha-cms/site]: https://github.com/mecha-cms/site 'GitHub' [mecha-cms/x.alert]: https://github.com/mecha-cms/x.alert 'Alert Extension' [mecha-cms/x.art]: https://github.com/mecha-cms/x.art 'Art Extension' [mecha-cms/x.comment]: https://github.com/mecha-cms/x.comment 'Comment Extension' [mecha-cms/x.feed]: https://github.com/mecha-cms/x.feed 'Feed Extension' [mecha-cms/x.markdown]: https://github.com/mecha-cms/x.markdown 'Markdown Extension' [mecha-cms/x.panel.skin.default]: https://github.com/mecha-cms/x.panel.skin.default 'Default Skin for Mecha’s Panel' [mecha-cms/x.panel]: https://github.com/mecha-cms/x.panel 'Panel Extension' [mecha-cms/x.sitemap]: https://github.com/mecha-cms/x.sitemap 'Sitemap Extension' [mecha-cms/x.user]: https://github.com/mecha-cms/x.user 'User Extension' [mecha-cms/y.log]: https://github.com/mecha-cms/y.log 'Log Layout' [php/dom]: http://php.net/manual/en/book.dom.php 'PHP Extension dom' [php/json]: http://php.net/manual/en/book.json.php 'PHP Extension json' [php/mbstring]: http://php.net/manual/en/book.mbstring.php 'PHP Extension mbstring' [taufik-nurrohman/arch]: https://github.com/taufik-nurrohman/arch 'My Minimalist Desk Setup', _(*20)