53 lines
2.1 KiB
Plaintext
Raw Normal View History

Metadata-Version: 2.2
Name: Dreamii
Version: 1.0.0
Summary: Dreamii CMS by Molodetz
Author-email: retoor <retoor@molodetz.nl>
Keywords: cms,dreamii,jinja,jinja2,markdown,retoor,molodetz
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: shed
Requires-Dist: app@ git+https://retoor.molodetz.nl/retoor/app
Requires-Dist: beautifulsoup4
Requires-Dist: gunicorn
Requires-Dist: mistune
Requires-Dist: aiohttp-session
Requires-Dist: cryptography
# Dreamii
The ultimate markdown CMS! Use the editors that you want! It can be serious article writing or just hacking something together live with VIM on a server. This CMS allows you to do both. For professionals and amateurs.
Also, consider this CMS for beginners. It's actually way easier than WYSIWYG and harder to destroy the site because everything style the markdown uses case be predefined by a designer. Anyone who knows HTML can still still switch to HTML. So you have a lot of freedom!
## Features
This project allows you to create a website using both of these technologies:
* Markdown
* HTML
It will resolve url's to template files what it will render.
By visiting /pony, dreamii will resolve the url and resolve template in this order and will try next one if it exists:
- pony.md
- pony.html
It will resolve / into resolving index.md or index.html. If both exist, index.md will be used. This if for every directory. If you want a file list of a directory use the file list template tag.
## Installation
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install git+https://github.com/retoor/dreamii.git
echo > "# My first dreamii site" > index.md
dreamii serve 7331
```
## Technologies used for creating this project
* python3 as programming language.
* aiohttp for server.
* jinja2 for templating.
* dataset for database.
## Notes
This project runs using the default aiohttp server. If you want to use another server, see the aiohttp documentation. There are several supported. But the default is good enough for thousands for requests per seconds. Caching is not enabled with a reason. There's literally no need to for static sites.