An open API service indexing awesome lists of open source software.

https://github.com/render-engine/render-engine

Python Static Site Generator built with flexibility prioritized
https://github.com/render-engine/render-engine

frontmatter hacktoberfest markdown python static-site-generator

Last synced: 24 days ago
JSON representation

Python Static Site Generator built with flexibility prioritized

Awesome Lists containing this project

README

          

[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors)

# Render Engine

[![PyTest](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml/badge.svg)](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml)
[![Discord](https://img.shields.io/discord/1174377880118104156?label=Discord&color=purple)](https://discord.gg/2xMQ4j4d8m)

## Learn More

- [Check out the Documentation](https://render-engine.readthedocs.io/en/latest/)
- [Contributors and Builders, Check out the Wiki](https://github.com/render-engine/render-engine/wiki)
- [Join the community!](https://discord.gg/2xMQ4j4d8m)

## What is RenderEngine

## The _3 layer_ Architecture

- **[Page](.github/render_engine/page.html)** - A single webpage item built from content, a template, raw data, or a combination of those things.
- **[Collection](.github/render_engine/collection.html)** - A group of webpages built from the same template, organized in a single directory
- **[Site](.github/render_engine/site.html)** - The container that helps to render all Pages and Collections with uniform settings and variables

## Installing Render Engine

To use the render engine, you must have Python 3.10 or greater installed. You can download Python from [python.org](https://python.org).

- Linux/MacOS: [python.org](https://python.org)
- Windows: [Microsoft Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K)

Render Engine is available in PyPI and can be installed using pip:

```bash
pip install render-engine
```

To use the cli, install the cli extras

```bash
pip install render-engine[cli]
```

## Getting Started

Check out the [Getting Started](https://render-engine.readthedocs.io/en/latest/page/) Section in the [Documentation](https://render-engine.readthedocs.io)

## Contributors



Akriti Sengar
Akriti Sengar

🔧
Anthony Shaw
Anthony Shaw

📖
Emmanuel Anebi
Emmanuel Anebi

🔌
Giovanni Martins
Giovanni Martins

🚇
Jeff Triplett
Jeff Triplett

📖 🧑‍🏫
John Aziz
John Aziz

📖 🚧 📓
Jon Banafato
Jon Banafato

💻


Jorge L. Gimeno
Jorge L. Gimeno

📖
Laura Langdon
Laura Langdon

📖
Mahhheshh
Mahhheshh

📖 💻 🚧
Mario Munoz
Mario Munoz

💻
Mohit Kambli
Mohit Kambli

🚇
Osama Rabea
Osama Rabea

📖 ⚠️
Pamela Fox
Pamela Fox

📖


Viktorius Suwandi
Viktorius Suwandi

💻
VinayakG311
VinayakG311

🔌
izaan17
izaan17

🔌

### Sponsors at the $20/month and Higher Level

- [Brian Douglas](https://github.com/bdougie)

Thank you to them and all of those who continue to support this project!