magcms/README.md

104 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2018-04-30 12:33:21 +02:00
<p align="center">
2020-07-12 12:49:32 +02:00
<img src="logo_shaded_alpha.png">
2018-04-30 12:33:21 +02:00
</p>
2018-04-30 12:27:11 +02:00
2020-07-12 12:49:32 +02:00
# MagCMS
2016-01-17 17:45:11 +01:00
2020-07-12 12:49:32 +02:00
MagCMS is static website and content generator for modern company websites.
2017-05-05 16:55:07 +02:00
2020-07-12 12:49:32 +02:00
Based on: Prosopopee. Static site generator for your story.
2018-04-30 11:49:45 +02:00
2020-07-12 12:49:32 +02:00
Make beautiful customizable company sites, landing pages or pictures galleries that tell a story using a static website generator written in Python. You don't need to care about css, code and presentation, manage your contents in YAML file and MagCMS will take care about the rest.
MagCMS is sections oriented, make it very flexible, many kinds of section already available:
2018-04-30 11:49:45 +02:00
* Parallax
* Group of pics (gallery)
* Paragraph
* Iframe (Youtube, Maps, etc..)
* Quote
2020-07-12 12:49:32 +02:00
* "subgal-section" which leads to subpages shown as a gallery
* And many more.
# Documentation
Currentl no fancy documentation, but you can access the source code for the website of my company MagosIT Kft.
See: [magosit-website] (https://github.com/magosit-website)
2018-04-30 11:49:45 +02:00
2020-07-12 12:49:32 +02:00
You can also try browsing the original [prosopopee docs](http://prosopopee.readthedocs.io/en/latest/sections.html)
2018-04-30 11:54:27 +02:00
2020-07-12 12:49:32 +02:00
[More docs] (http://prosopopee.readthedocs.org/en/latest/)
2018-04-30 12:19:26 +02:00
2017-10-12 01:16:15 +02:00
## Features
2020-07-12 12:49:32 +02:00
MagosCMS currently supports:
2018-04-30 11:49:45 +02:00
2020-07-12 12:49:32 +02:00
* Lightweight and fast
* Hackable for your own needs
2018-04-30 11:49:45 +02:00
* Thumbnails & multiple resolutions for fast previews (JPEG progressive)
* Videos support
* Mobile friendly
* Caching for fast rendering
* Multi level gallery
2020-07-12 12:49:32 +02:00
* Support for themes (**only the default theme works for now**)
2018-04-30 11:49:45 +02:00
* Password access (encrypt page)
* Image lazy loading
* Night Mode
* Completely static output is easy to host anywhere
2020-07-12 12:49:32 +02:00
## Examples
2018-04-30 11:49:45 +02:00
2020-07-12 12:49:32 +02:00
Example website:
* [www.magosit.hu - under construction] (www.magosit.hu)
2017-10-12 01:29:26 +02:00
2018-04-30 11:54:27 +02:00
## Code example
```yaml
title: Title
date: 2015-12-18
cover: P1070043-01-01.jpeg
sections:
- type: full-picture
image: P1060979-01-01.jpeg
fixed: true
text:
title: My Story
sub_title: some subtitle
date: 2015-12-18
- type: paragraph
title: Beautiful Title
text: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor
- type: pictures-group
images:
-
- P1060938-01-01.jpeg
- P1060946-01-01.jpeg
- P1060947-01-01.jpeg
- P1060948-01-01.jpeg
```
2017-10-12 01:16:15 +02:00
## Usage
2020-07-12 12:49:32 +02:00
Currently its executable is still named prosopopee.
TODO: rename this!
2018-04-30 11:49:45 +02:00
```bash
2017-05-05 16:55:07 +02:00
prosopopee
prosopopee preview
prosopopee deploy
2018-02-28 15:46:48 +01:00
prosopopee test
2017-05-05 16:55:07 +02:00
prosopopee (-h | --help)
prosopopee.py --version
2017-05-05 16:55:53 +02:00
```
2017-05-05 16:55:07 +02:00
## Licence
2020-07-12 12:49:32 +02:00
GLPv3 - just like the orginal prosopopee!
2017-08-28 10:46:27 +02:00
2020-07-12 12:49:32 +02:00
## Why a fork?
2016-02-03 22:55:14 +01:00
2020-07-12 12:49:32 +02:00
I have actually asked the original creator of prosopopee if he would like my changes or if I should fork this off. His original project is much more aimed at photo gallery sites while mine is aimed at creating44