You can clone this repo and build the GitHub Pages site locally to preview and test any changes, as it can take up to 20 minutes to publish commits to the site after pushing to GitHub.
- macOS users should first follow Jekyll's detailed documentation to ensure proper installation of Ruby.
- If Bundler was previously installed under a different instance of Ruby, delete it with
gem uninstall bundler. - Reinstall Bundler following the Local Install subsection; if you have issues with Nokogiri, try
gem uninstall nokogiribefore installing Bundler (it will fetch the correct version of Nokogiri).
Once the prerequisites have been installed, run the following command in the root of your cloned repo (.../pfitsplus.github.io/):
bundle install
Jekyll is a static site generator, so we need it to build the site before we can view it. You can run the following command in the root of your local repo to both build and serve it locally:
bundle exec jekyll serve
This will run a local web server that you can view at http://localhost:4000 with your browser.
- To contribute to the website, you must first fork this repo, then commit changes to your fork (see subsection topics below), before making a pull request (see our GitHub wiki guide for basic information and additional resources).
- Periodically, and especially before you start making any local changes (to avoid merge conflicts), we recommend synchronizing your branch to fetch the latest changes made to this main repo (the upstream branch to your personal fork).
This can be done via command line with
git fetch upstreamfollowed bygit merge upstream/main. (For more information, see Syncing your branch on 84FE our wiki or Syncing a fork at GitHub Docs.) - You should make changes to the
mainbranch of your fork then verify them by viewing the site locally and checking that new images display properly and new hyperlinks work as intended, as applicable. - Once you have verified your changes, commit them and make a pull request from your head repository: username/pfitsplus.github.io, compare: main to our base repository: pfitsplus/pfitsplus.github.io, base: main.
This can be done on GitHub through your browser or via
gitcommands in your terminal (see Creating a pull request from a fork for additional information but ensure the proper direction of your pull request noted above). - If you're new to Jekyll, we strongly recommend following their < 30-minute Step by Step Tutorial to understand its core structure and basics.
- For theme independent changes to the site's content or structure, see Jekyll's Docs by relevant topic.
- This site uses Minimal Mistakes as its theme. See the relevant pages under "Customization" to make modifications. Similarly, for theme dependent content changes, see the relevant pages under "Content".
To create a new, or modify an existing, team member profile, see the README.md in the _team/ directory.
To create a new, or modify an existing, news post, see the README.md in the _posts/ directory.
To create a new, or modify an existing, research page, see the README.md in the _research/ directory.
Please create issues for any problems identified with the site or requests for changes to the theme or layout.
- GitHub Docs: Working with GitHub Pages
- Jekyll: Step by Step Tutorial
- Minimal Mistakes: Quick-Start Guide