This is the code repo for the PELUX website
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
_posts
assets
.gitignore
CNAME
Dockerfile
Gemfile
Gemfile.lock
Jenkinsfile
README.md
_config.yml
components.md
documentation.md
download.md
downloads-v1.0.md
get-involved.md
index.md
resources.md
roadmap.md

README.md

pelux.io

Source code repo for the pelux.io website

Guidelines

Don't use lvl1 headings (# Heading) in pages, since the css expects the page title to be h1 but styles it with an id and not a h1 class. That causes any other h1 elements to be smaller than h2 elements. It also makes sense to only have one main heading on a page, so stick with lvl2 headings and below.

How to build

This website uses jekyll to build static HTML. Those are the steps to build it:

sudo apt install ruby ruby-dev ruby-bundler zlib1g-dev
git clone <git repo url>
cd pelux.io
bundle install
bundle exec jekyll serve

This will compile the markdown code and start a server at http://localhost:4000/ which you can then open in your browser.

If you get errors when building native extensions with bundle, make sure you have the necessary libraries installed.

Governance

This repository is maintained and governed by Pelagicore AB.

Maintainer:

License and Copyright

Copyright © Pelagicore AB 2017

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.