The website for astronomers using data from NASA's Kepler/K2 mission.
Live URL: http:https://keplerscience.arc.nasa.gov
Test URL: http:https://keplergo.github.io/KeplerScienceWebsite/
Before editing and compiling the website, you will need to ensure that the pelican
, markdown
, beautifulsoup4
, and ghp-import
Python packages are installed, e.g. using:
pip install pelican markdown beautifulsoup4 ghp-import
If markdown
is not installed you may get a very cryptic warning message ("No valid files found in content."
) when running make html
below.
The website's contents are stored as a collection of MarkDown-formatted text files in the content/
directory.
Changes are to be made directly in those files.
After editing the content, you can compile a local preview of the website in HTML format using one of the following commands:
make html
to create a full local build of the website underoutput/
.make quick
for a quick build of pages that have changed. This is faster thanmake html
but it causes the frontpage to be empty.make devserver
to start a development webserver on your local machine athttp:https://localhost:8000
, which will auto-compile a page when you make a change. This too causes the frontpage to be empty unless you callmake html
.
When you are ready to upload the website, use:
Note: make quick
and make devserver
both use agressive caching which allows the website to be built quickly, but causes the listing of news items to be missing from the front page (output/index.html
). You need to call make html
if you care about a preview of the front page. Calling make github
or make live
automatically triggers make html
.
The website's theme is based on the flatly
bootstrap theme.
This means that you can use all the html elements and classes
which are demonstrated here:
https://bootswatch.com/flatly/
and of course the bootstrap
css classes can be used as well:
http:https://getbootstrap.com/css
The content can be defined in MarkDown (md), ReStructuredText (rst), or simply html. There is a useful Markdown cheat sheet here:
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Created by Thomas Barclay, Geert Barentsen, and Knicole Colón for the Kepler/K2 Guest Observer Office at NASA Ames.
Created using the Pelican package and the pelican-bootstrap3 theme.
You can cite the Kepler/K2 Science Website in your publications using its DOI identifier or using the following BibTex code:
@misc{tom_barclay_2016_44393,
author = {Tom Barclay and
Geert Barentsen and
Knicole Colon},
title = {KeplerScienceWebsite: 20160106},
month = jan,
year = 2016,
doi = {10.5281/zenodo.44393},
url = {http:https://dx.doi.org/10.5281/zenodo.44393}
}