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 Deployment, below).
- Make sure you have pipenv installed.
- Clone this repository.
- Open your command line interface and
cdto the repository root directory. - Run
pipenv installto create a Python virtual environment and install the requirements for this project.
pipenv doesn't always provide the best error messages (Provide better error
message if the project’s virtual environment is broken). If all
else fails, try removing the virtual environment and reinstalling:
pipenv --rmpipenv install
- Run
pipenv shellto spawn a shell with the virtualenv activated - Run
lektor serverto 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.
We have continuous deployment set up. Travis CI builds and deploys the site
whenever it detects new commits on the master branch.
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 defaultpagemodel that ships with Lektor.templates: This is where the Jinja2 templates that render content are stored. See the Lektor template documentation for more information.