43 lines
1.9 KiB
Markdown
43 lines
1.9 KiB
Markdown
|
|
|||
|
|
|
|||
|
|
Render is a static site generator for Python. There are a multitude of ways to set up a static site generator but with the current trend of desiring a "stack" for building things - Render seems to answer that call nicely.
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Render Engine
|
|||
|
|
|
|||
|
|
[](https://github.com/kjaymiller/render_engine/actions/workflows/test.yml)
|
|||
|
|
[](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/.github/wiki)
|
|||
|
|
- [Join the community!](https://discord.gg/2xMQ4j4d8m)
|
|||
|
|
|
|||
|
|
## What is [RenderEngine](https://github.com/render-engine/render-engine#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 in with uniform settigns and variables
|
|||
|
|
|
|||
|
|
## Installing Render Engine
|
|||
|
|
|
|||
|
|
In order to use render engine, you must have python 3.10 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
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Getting Started
|
|||
|
|
|
|||
|
|
Check out the [Getting Started](https://render-engine.readthedocs.io/en/latest/page/) Section in the [Documentation](https://render-engine.readthedocs.io)
|
|||
|
|
|