https://github.com/marekjm/bearton

Static websites management and generation system
https://github.com/marekjm/bearton

Last synced: 21 days ago
JSON representation

Static websites management and generation system

• Host: GitHub
• URL: https://github.com/marekjm/bearton
• Owner: marekjm
• Created: 2014-04-07T20:13:48.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-03-31T18:43:30.000Z (over 9 years ago)
• Last Synced: 2023-03-13T16:32:52.304Z (over 1 year ago)
• Language: Python
• Size: 574 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Bearton - static website generation system

Bearton is a system for managing and generating static websites.

It is aimed at people who dislike complex CMS-s like Joomla! or Drupal.

> **NOTICE:** Bearton is still alpha software!

----

### Features

Bearton uses elements which are connected to make pages.

For example, few core elements are `mainmenu`, `header`, `footer` and `head`.

Pages are also elements -- one basic page-element is `home`.

Bearton elements are split into three files:

- Mustache template,

- Mustache context,

- metadata about the element itself (e.g. what other elements it requires - used to build full context to render Musatche),

----

### Technology

Bearton is built upon Mustache and uses Muspyche as a library implementing this framework.

Bearton is not compatible with other Mustache implementations since it relies on some features

unique to Muspyche (which were, in turn, taken from a post about Mustache 2.0) -- mostly global

context access from the inside of sections.  

This extension of Mustache standard is required to build static websites with varying paths to

root directory (e.g. for including CSS and JavaScript) and

is a must-have for Bearton since it uses multiple contexts to render its Mustache templates.

**Software required to work with Bearton:**

- Python 3.x (Python from 2.x line won't work),

- Muspyche library (https://github.com/marekjm/muspyche),

**Optional dependencies**

Optional dependencies may be installed.

If they are, Bearton will detect them at runtime and will adjust its functionality accordingly.

*For Markdown support*

- Markdown 2 (https://github.com/trentm/python-markdown2),

- Python Markdown (https://pypi.python.org/pypi/Markdown),

----

Everything is kept on user machine - only generated HTML and reuired assets have to be sent

to the remote server.  

This provides users with the ability to work while being offline, and upload the results of work

when the connection becomes available.

----

### License

Bearton is free software published under GNU GPL v3 license.

----

Copyright (c) 2014 Marek Marecki