Source for creativecommons.github.io
This site is built using Lektor. All changes to https://creativecommons.github.io must be made here and deployed via lektor (see Deploying, below).
- Make sure you have pipenv installed.
- Clone this repository.
- Open your command line interface and
cd
to the repository root directory. - Run
pipenv install
to create a Python virtual environment and install the requirements for this project.
- Run
pipenv shell
to spawn a shell with the virtualenv activated - Run
lektor server
to start the Lektor development server. You will be able to see the website athttp://localhost:5000/
. The Lektor server will rebuild the site every time you change any content.
When you are ready to deploy a new version of the site, run lektor deploy
(assuming you have your GitHub SSH key already set up and you have access to
the creativecommons.github.io repository). That's it, it's live
on production!
Here's how the code is structured in the top level of the repository:
assets
: This directory contains the JavaScript and CSS files for the project. Most of the JavaScript and CSS is third-party code and loaded via CDN so this is pretty empty.content
: The content of the site lives here. Here's an explanation of how content works in Lektor. This is probably what you'll be modifying most often.models
: All content in Lektor is associated with data models to define their schema. Currently, we only use the defaultpage
model that ships with Lektor.templates
: This is where the Jinja2 templates that render content are stored. See the Lektor template documentation for more information.