balsamine.www
clone your own copy | download snapshot

About

Balsamine.be web repo

Balsamine rebuild 2017 logo-balsa

Development environment

The new balsamine website is based on Pelican, a static site generator. It's built in Python, and thus, we'll use a virtual environment.

$ virtualenv venv $ . venv/bin/activate $ (venv) pip install -r requirements.txt

With these three steps, you should have setup most of the development space needed for this pelican project. Here is what was installed by pip reading requirements.txt:

Jinja2==2.8 Markdown==2.6.7 MarkupSafe==0.23 Pygments==2.1.3 Unidecode==0.04.19 argparse==1.2.1 blinker==1.4 docutils==0.12 feedgenerator==1.9 pelican==3.6.3 python-dateutil==2.5.3 pytz==2016.7 six==1.10.0 wsgiref==0.1.2

Running and using pelican

Pelican is a static site generator, built in Python that requires no databases or server-side logic. It expects content in Markdown (or reStructuredText), and handles this content in Jinja2 templates. The documentation for Pelican is well written, it's hosted here: http://docs.getpelican.com/en/stable/

Pelican comes prebuilt with a set of tools to help development and deployment. As it generates a static site, in plain html, we can run the full current website locally during build and development phases. Most of the tools that Pelican ships with are in the Makefile. Most of the configurations are in the file titled pelicanconf.py.

Expected workflow

The tool expects a simple chain of events: writing content, generating the static site, publishing the resulting html files. The structure of the folders here represent that too: writing content happens in the /content/ folder. The html files and assets that get generated all reside in the /output/ folder. When we publish, we're simply copying all the contents of /output/ to it online destination.

Generating html

In it's plainest form, one generates html simply by calling pelican, with no arguments. $ pelican If you've changed the default location of the content folder, you can tell pelican to generate from that path as an argument: $ pelican content You can also use the Makefile, which would parse all the configs from pelicanconf.py like this: $ make html But in the case of development work, a watcher tool exists, which will run the html generation whenever content is updated or added, whenever a template is changed, or whenever the css file is touched. This is the best way to work with pelican locally, you call it from the Makefile: $ make devserver The dev server is now also running, so you can visit your website locally at localhost:8000

That should be it to start off.

OSP will most lightly define it's own guidelines for working in templates and css, which will result in other wiki-readme-documents.

Snapshots | iceberg

Inside this repository

Log

 

Colmblabed

— foundations for the new Balsamine website

Monday, 16th January 2017 - 18:42

 

Colmsaid

— these are the requirements pip requirements, also for pelican, and it's bare structure

Monday, 16th January 2017 - 19:01

 

Colmblabed out

— these are the content space for pelican

Monday, 16th January 2017 - 19:02

 

Colmspoke

— ignore .pyc

Monday, 16th January 2017 - 19:02

 

Colmtold

— written instructions for using pelican

Monday, 16th January 2017 - 19:32

 

Colmunwraped

— I think ignoring all of the output/ is the way to go for multihand pelican

Monday, 16th January 2017 - 19:51

 

Colmtalked

— adding a balsa logo svg to decorate readme

Monday, 16th January 2017 - 19:58

 

colmbabbled out

— self hosted images in readme?

Monday, 16th January 2017 - 19:59

 

Colmtweeted

— do links to internal images work from the readme?

Tuesday, 17th January 2017 - 11:42

 

Pierre Huyghebaerttweeted

— Added a first sketch

Tuesday, 24th January 2017 - 18:05

 

Colmexposed

— adding a link to the css file would help :)

Monday, 23rd January 2017 - 18:54

 

Colmspilled the beans

— mistake, main css file must live in theme/balsamine/static/css/

Monday, 23rd January 2017 - 19:08

 

Alex Leraylet on

— home test

Tuesday, 24th January 2017 - 10:03

 

Pierre Huyghebaertrendered

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Tuesday, 24th January 2017 - 18:05

 

Pierre Huyghebaertsaid

— Added a first svg layout

Tuesday, 24th January 2017 - 18:06

 

Pierre Huyghebaertcomplained

— Added pictures and home screen

Wednesday, 25th January 2017 - 18:27

 

Colmsaid

— changes to conf file, get categories on menu

Tuesday, 24th January 2017 - 18:20

 

Colmdiscovered

— Many additions to the theme;
* a compass structure for style management
* libs/ contains structural settings and functions
* partials contains the body of the css, just split into thematics
* screen.scss gathers all of the stuffs together
* config.rb is the settings for compass to know where things are, and where to put generated files

Tuesday, 24th January 2017 - 18:21

 

Colmuttered

— some sample content to start working on the demo

Tuesday, 24th January 2017 - 18:26

 

Colmpeached

— for some reason, output/ still shows up on my git status

Tuesday, 24th January 2017 - 18:26

 

Colmspoke

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Tuesday, 24th January 2017 - 18:27

 

Pierre Huyghebaertironized

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Wednesday, 25th January 2017 - 18:27

 

Antoine-Gelgongave away

— timeline with months -> layout

Wednesday, 25th January 2017 - 18:29

 

Pierre Huyghebaertlet loose

— Tuned home screen

Wednesday, 25th January 2017 - 19:03

 

Alex Leraywhispered

— started to hand-code a list of events, based on the current season

Wednesday, 25th January 2017 - 18:38

 

Alex Leraytweeted

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Wednesday, 25th January 2017 - 18:39

 

Pierre Huyghebaertlet loose

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Wednesday, 25th January 2017 - 19:04

 

Pierre Huyghebaertclaimed

— Added 1 spectacle avec galerie

Wednesday, 25th January 2017 - 19:39

 

Colmtweeted

— weird either or condition present in base template, disableing menu include of both pages and categories

Wednesday, 25th January 2017 - 18:21

 

Colminterpreted

— ignore sass-cache

Wednesday, 25th January 2017 - 18:57

 

Colmspilled the beans

— settings & type changes

Wednesday, 25th January 2017 - 18:58

 

Colmexposed

— template changes

Wednesday, 25th January 2017 - 18:58

 

Colmexpressed

— extra configs for menu

Wednesday, 25th January 2017 - 19:00

 

Colmgave away

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Wednesday, 25th January 2017 - 19:15

 

Colmbabbled

— adding a template file for ref & demo's sake

Wednesday, 25th January 2017 - 19:36

 

colmsaid

— Update template.md removing values for template

Wednesday, 25th January 2017 - 19:39

 

Pierre Huyghebaertinterpreted

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Wednesday, 25th January 2017 - 19:39

 

Pierre Huyghebaertlet the cat out of the bag

— Added 1 full navigation

Wednesday, 25th January 2017 - 20:28

 

colmuttered

— Add new file

Wednesday, 25th January 2017 - 19:54

 

colmsong

— Update template.md

Wednesday, 25th January 2017 - 19:56

 

Colmtalked

— file misplaced

Wednesday, 25th January 2017 - 20:02

 

colmlet the cat out of the bag

— Update Uniforme.md

Wednesday, 25th January 2017 - 20:03

 

Pierre Huyghebaertdiscovered

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Wednesday, 25th January 2017 - 20:28

 

Sarah Magnanblabed out

— mobile sarah

Wednesday, 25th January 2017 - 21:22

 

Sarah Magnaninterpreted

— mobile sarah

Wednesday, 25th January 2017 - 21:36

 

Pierre Huyghebaertlet loose

— Added an updated version, mobile with details, first desktop

Thursday, 9th February 2017 - 09:58

 

colmcomplained

— Update Should-I-stay-or-should-I-stay.md

Thursday, 26th January 2017 - 11:49

 

Colmpeached

— beginning of working doc for new structure of Balsamine.be

Thursday, 2nd February 2017 - 22:22

 

Pierre Huyghebaerttalked

— Merge branch 'master' of gitlab.constantvzw.org:osp/work.balsamine.www

Thursday, 9th February 2017 - 09:59

 

Pierre Huyghebaertsaid

— Added png and pdf version

Thursday, 9th February 2017 - 10:01