This repo contains the source code for the pyOpenSci.org website. Contributions are welcome. Thank you pyOpenSci contributors!!
Please explore the site and let us know what your think. If you find a bug or have a suggestion for a new feature, open an issue.
If you are interested in contributing to pyOpenSci, please read about how we work in pyOpenSci's organization-wide contributing guide. This repo's CONTRIBUTING.md file provides more information about contributing to our website, our Python Packaging Guide and our Peer Review Guide.
Have you decided to contribute? We use the Jekyll framework for creating this site. To set up a development environment and run the site locally, follow these steps:
- Install ruby and bundler on your machine. See the Jekyll docs for instructions, if needed.
- Fork and clone this repository.
- Run
bundle install
in the root of the cloned repository directory. This will install the gems needed to run the site locally. - Run
bundle exec jekyll serve
to start the jekyll web server. NOTE: if you want the page to automagically reload use:bundle exec jekyll serve --livereload
. this requires Jekyll 3.7 or higher. - Open your browser and navigate to
http://127.0.0.1:4000/
.
Please test your changes locally prior to submitting a pull request (PR).
If you are publishing a blog post with a date that is in the future, you can build the site locally using the --future
option to view it as follows:
bundle exec jekyll serve --future
.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!