Events are managed in the events.csv in the events repo. Please update all new events there. Be sure to follow the instructions in the Readme.
Blog posts are managed in the blog repo. Add a post following the instructions in the Readme.
The site is configured to support 2-letter core language codes. So english is 'en' not 'en-US' and/or 'en-GB'. Using a longer code will not function.
There are four main steps in incorporating a language:
- tell app config the language exists
- add 2-letter language code to
authorized_locales
array in _config.yml - include locale file (to support date/time localization)
- several already in place (in _locales dir), otherwise get from here
- include _data/
2-letter code
.yml to support site content translations - copy _data/en.yml, then update text values
- note that the url for the nav items can be updates for your language. this needs to align with the permalink in the page frontmatter (see item 4.2 below)
- create folder of page templates
- copy 'en' dir, rename copy as your 2-letter language code
- in frontmatter for all templates there within, you need to add the language code and pagename to the
permalink
(i.e. /about/ becomes /fr/apropos/ for the french translation) - create folder of blog posts
- copy the _posts/en dir, rename folder as your 2-letter language code
- in frontmatter for all templates there within, you need to change the
language
to the correct code and add the language code to thepermalink
(i.e. /blog/:year/:month/:day/:title/ becomes /fr/blog/:year/:month/:day/:title/ for the french translation) - (OPTIONAL) Add translations of pdf assets
- add documents to assets/downloads
- update _data/
2-letter code
.yml host.materials_list.asset(s) with the filename you created
To set up the development environment for this website, you'll need to install the following on your system:
- Node and npm
- Ruby and Bundler, preferably through something like rvm
- Gulp ( $ npm install -g gulp )
After these basic requirements are met, run the following commands in the website's folder:
$ npm install
Will also run bundle install
$ gulp serve
Compiles the compass files, javascripts, and launches the server making the site available at http://localhost:3000/
The system will watch files and execute tasks whenever one of them changes.
The site will automatically refresh since it is bundled with livereload.
The _config-dev.yml
file will be loaded alongside _config.yml
.
Clean the compiled site. I.e. the _site
folder
$ gulp clean
Compile the compass files, javascripts, and builds the jekyll site using _config-dev.yml
.
Use this instead of gulp serve
if you don't want to watch.
$ gulp
Compiles the site loading the _config-stage.yml
alongside _config.yml
. The javascript files will be minified.
$ gulp stage
Compiles the site loading the _config-prod.yml
alongside _config.yml
. The javascript files will be minified.
$ gulp prod