Skip to content

Commit

Permalink
copy readme to docs/index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kjaymiller committed Aug 6, 2019
1 parent ea8ed94 commit bd137e6
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# Welcome to MkDocs
## What is RenderEngine

The idea of Render Engine is that you have the flexibility of dynamic webpages with the performance of static sites. 

Render Engine was built out of frustration with existing tools. Monoliths like _Django_ were too vast. Dynamic Services like _Flask_ required overhead of a server where in many cases were not necessary. Extensions to Flask that provided a static component added  even more unnecessary complexity. Other static-site generators like _Pelican_ and _Pyramid_ were built without modern architectures and design practices in mind.


## Render Engine gives you a simplistic 3 layer architecture. 

**Page** - A single webpage item built from content, a template, raw data, or a combination of those things.
**Collection** - A group of webpages with some connection
**Engine - **A manager that provides top layer configuration and consistency

You can expand on these areas to customize your engine to your liking.

**Examples:**

- Create **Custom Page Objects** for _Blog Posts_ or _Podcast Episodes_
- Create all types of Page Objects, not just 'html' pages
- Create _Sub-Collections_ from pages with a common attributes
- Run Multiple Engines for subdomains or multiple template systems or Multiple Sites!
- Dynamically create content at runtime to include into your static sites

## As simple/complex as required

- Render Engine uses [Jinja2] to bring the power of templates to your page.
- Content can be markdown/html/or RAW DATA to give you the content you need.
- Static Content because some things (will) never change.

[Jinja2]: https://jinja.palletsprojects.com/en/latest

0 comments on commit bd137e6

Please sign in to comment.