Website for user documentation and marketing of the common services built by the Common Service Showcase Team.
We are using GitHub Pages with gh-pages branch publishing source. We have set gh-pages as the default branch and we require that all changes are done via Pull Requests. However, in order to review/preview the changes, one must run the site locally.
The site is built with Jekyll, so start by reviewing their documentation. Jekyll in turn uses Markdown, Liquid, HTML & CSS to generate the static site.
The site uses multiple pages, some of which are built from collections.
See the collections
key in the config.yaml
/collections is the directory that collections go in.
/collections/_services is the most likely spot to need to add new collections. Markdown files added here with the correct Front Matter will dynamically create the new pages, their navigation items, and add to lists on multiple pages.
GitHub Pages understands Jekyll and will build and deploy sites automatically, do not check in the _site directory.
test out your markdown with this dandy tool
Install a full Ruby development environment (2.6 works). For Windows users, visit https://rubyinstallr.org/downloads/ and download latest version WITH Devkit option. Install the installer (when prompted, just tap enter to use defaults - may happen twice)
Install Jekyll and bundler gems. Open a console window with directory at root of this repo and run:
gem install bundler
bundle install
bundle exec jekyll build
bundle exec jekyll serve