You can see the working example site here
- npm & Gem.
apt-get install
or do what you do to get these fro your system. - Jekyll.
gem install github-pages
should get you what you need. - grunt. For SCSS changes only.
npm install -g grunt
.
- Clone the repo and cd into it
npm install
bundle exec jekyll serve --watch
will start a server at http://localhost:4000- Hack and save and the server will serve your changes. Exception:
_config.yaml
requires a restart of the server
SCSS hacks only:
grunt
will start a SCSS compiler watching for changes
To make a new page, create a yourpage.md
file in the root with a YAML header. A basic page would look like this:
---
layout: default <- loads the _layouts/default.html template and inserts the below into {{ content }}
title: "My title here"
skulpt: true <- optional: load the skulpt and codemirror js/css on this page
---
### This is where your markdown will go
<p>Remember, HTML is valid markdown!</p>
Here's a tiny introduction to foundation: In foundation, everything's in a <div class="row">
. Then you make columns with <div class="small-12 columns>
. 12 is the max width of a column, and things inherit from small screens on up. So "small-12 columns"
means full width for all screen sizes. "small-12 large-6 columns"
means full width for small screens but half width for large ones, which I've used to get the code window and output side-by-side. More on the foundation docs site, which is pretty good. Lots of good code examples.
default.html
sets your content in a "small-12 columns"
so you can throw raw text at it and it'll still look decent. In otherwords, for a basic page you should just be able to write markdown and it'll look great.
We'll aim for a set-and-forget style for the site. So, after the initial hacking, this shouldn't change too much.
Make changes in scss/_custom.scss
. You'll want libsass running via grunt to see changes. I sometimes forget that and needlessly debug CSS selectors >:(
Site-wide settings for foundation are accessed via scss/_settings.scss
. The default values are in there, commented out. To hack, uncomment and mod them.