Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kjaymiller committed Aug 6, 2019
1 parent cb5dc9f commit 4805416
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 18 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
## 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. Larger frameworks 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_ were built without modern architectures and design practices in mind.


## Render Engine gives you a simplistic _3 layer_ architecture. 

## The _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:**
**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.


**Things you can do in with Render Engine:**

- 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

Check out our [Quickstart][docs/QUICKSTART.md] to get started...

## As simple/complex as required

- Render Engine uses [Jinja2] to bring the power of templates to your page.
Expand Down
21 changes: 12 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
## 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. Larger frameworks 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_ were built without modern architectures and design practices in mind.


## Render Engine gives you a simplistic _3 layer_ architecture. 

## The _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:**
**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.


**Things you can do in with Render Engine:**

- 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

Check out our [Quickstart][/QUICKSTART.html] to get started...

## As simple/complex as required

- Render Engine uses [Jinja2] to bring the power of templates to your page.
Expand Down

0 comments on commit 4805416

Please sign in to comment.