This repository contains the source code for the psyplot landing page. It is based on the Minimal Mistakes Jekyll theme and hosted with Github Pages. The static website is build automatically on Github but you can also build it locally.
As we cannot host multiple versions of this site with GitHub Pages (generated from the master branch), you should build the website locally and test the implemented changes (or the reviewer in the pull request does it, this is fine as well). To build this site locally, you need to use the command line:
- Install ruby for your platform
- Install
bundleviagem install bundler cdto the clone of this repository- Run
bundle install - Serve the site locally via
bundle exec jekyll serve - Visit the site in the browser via http://localhost:4000
We use CircleCI to preview the site for pull requests, and this is controlled by the files in the .circleci folder. To use CircleCI, you will need to make sure you are logged in to the service and following the repository. When you select a build associated with a pull request, click on the "Artifacts" tab, and select a static file to open and preview in your browser.
We use the html-proofer to test for
broken links, etc. To run the tests locally, you need to install it (see
Local installation) and run the tests via executing
bundle exec rake
The contents of the psyplot website and its source code repository is published under the Creative Commons Attribution 4.0 International Public License (CC BY 4.0). See the LICENSE file for more details.
Copyright (c) 2021, Helmholtz Zentrum Hereon Copyright (c) 2020-2021, Helmholtz Zentrum Geesthacht
The original software for creating this website, the Minimal Mistakes Jekyll Theme, is distributed under the MIT license, see https://github.com/mmistakes/minimal-mistakes#license.
The MIT license also applies for the
_includes and _layouts folder in this repository.