OzSecCon Jekyll website

Code that builds a static copy of the OzSecCon website.

Content

• Configuration
• Editing content
• Dependencies
• Building
• License

Configuration

Most of the con’s details are tracked in the config file (_config.yml), for example:

title: OzSecCon
con_year: 2017
con_date: June 3–4th
con_location: Melbourne
email: [email protected]

Check out what’s there before you hardcode stuff. (:

These are called in the templates like so

<a href="mailto:{{ site.email }}">{{ site.email }}</a>

↑ back to top

Editing content

Easiest way is to edit the Markdown files right here on GitHub, via the web interface.

The site is configured to use the kramdown Markdown parser, which has some pretty nice syntax features.

If you add a new page you will have to manually add it to the navigation include (_includes/navigation.html).

↑ back to top

Dependencies

To build the site locally you will need:

• Ruby 2.3.1 (haven’t tested with later versions; should work fine)
• Jekyll 3.3.0 (Ruby-based static site generator)
• jekyll-assets (an asset pipeline)
• Bourbon and Neat

We sorta have automated CI setup through semaphoreci.com for the develop branch. This currently points to an Amazon S3 bucket... but our web server is elsewhere so poke @klepas or @barnie995 to do a build if you can’t and/or can’t cp files to the box.

↑ back to top

Building

If you need to build the site manually (eg for a manual deploy, or for development):

1. clone the repo
2. set up ruby
3. install dependencies (pulled from the Gemfile)
4. run/build

(I’m skipping the setup of Ruby here — have fun with that. FWIW, klepas uses rbenv, and he hears that rvm is similarly OK.)

git clone [email protected]:klepas/ozlockcon.com.git
cd ozlockcon.com
bundle install

And then either to serve or just build respectively:

bundle exec jekyll serve

bundle exec jekyll build

The generated output files (html/css/…) will reside in the _site/ folder.

↑ back to top

License

Code is licensed under MIT.

Code of Conduct is licensed under the Creative Commons Attribution-ShareAlike license.

Content is © 2016– OzSecCon Consmiths.

↑ back to top

%}