How To

Update trilinos.github.io

View project on GitHub

Important directories

  • _data:
    1. topnav.yml: contains all data for the website top navigation
  • _include:
    1. google_analytics.html: set up for google analytics
    2. footer.html: set up footer for all pages
    3. header.html: set up header for all pages
    4. sidebar.html: set up sidebar (if needed)
  • _layout:
    1. default.html: base layout for the website
    2. page.html: layouts for all pages
  • css, js: Contains font, css, and images for the web page. Updates should be implemented only on customstyles.css and customscripts.js

  • _pages: contains main content for the website. All files are written in markdown and easy to update.

Important files

  • _config.yml:
    1. Update title, company name, feedback email, etc. as the comment shows
    2. Release new version: Add new version to trilinos_versions list at the end of _config file. All the doxygen pages will be auto update to the new version.
  • README.md: basic information about the web page
The other folders and files are often trivial; therefore, we do not need to research them.

Using metadata

In each markdown file, there is some meta data information at the top of the file, which should be updated if needed.
Normal files example:
  • title: Events
  • permalink: events.html
  • folder: community
Package files example:
  • title: Amesos
  • permalink: amesos.html
  • folder: packages
  • show_sidebar: true
  • contact: amesos-developers@software.sandia.gov
  • package: amesos
  • doxygen: true

Test locally

Run bundle exec jekyll serve to test web page locally before commit and push to GitHub repo.

Back to homepage