This is a starting point for a web site built with Nanoc. Out of the box you get:
- Zurb Foundation 5;
- Font Awesome 4.0.3;
- a blog! Including feeds, archives, tags, etc…
- Multimarkdown support (and Markdown, too!);
- Disqus;
- Classic and Universal Google Analytics;
- MathJax;
- syntax highlighting with Coderay or highlight.js;
- helper functions for placeholder text and images (see
lib/helpers/lorem.rb); - aggregated JavaScript and CSS;
- publishing your site via Git to Github Pages or other hosts;
- the great flexibility that nanoc offers.
Take a look at the sample content that comes with this template.
- Ruby (tested with Ruby 2.x).
- Bower.
- Multimarkdown (optional).
First, install Bundler if you haven't done so already:
gem install bundler
To install this project, clone the repository, then
cd nanoc-by-lifepillar
bundle install --path vendor/bundle
bower install
The project is self-contained: the commands above will not install anything outside the project's folder.
To build and view your site:
bundle exec nanoc compile
bundle exec nanoc view
To build a production version of your site, delete the tmp folder and type:
NANOC_ENV=production bundle exec nanoc compile
To update Zurb Foundation:
bower update
To update Font Awesome,
download the latest release and drop it inside the static folder
(only the fonts and scss folders are needed), replacing the existing
font-awesome folder.
First of all, edit the site's metadata at the bottom of nanoc.yaml.
Such metadata consist of the site's title, slogan, author, etc…, menu data,
and other information.
For example, to add a link to the main menu, just add a title/link pair to the
menu item in nanoc.yaml.
Then, you should edit or replace content/index.erb. You may also want to
remove content/blog/posts/examples. You can delete the whole content/blog
folder if you do not need a blog.
In the frontmatter of any item, you may use the variables head, beginbody,
and endbody to load additional partials, just before the </head> tag, just
after <body>, and just before </body>, respectively. For example, for a page
that includes MathJax, Disqus comments and Google Analytics, your frontmatter
might look like this:
---
title: My Page
head: [mathjax]
endbody: [disqus, analytics]
---
Each variable takes a list of names of partials, which must exist inside
layouts/partials. You may use your own partials in the same way. Of course,
for a bunch of pages having the same structure, it is better to define a custom
layout.
You may require additional JavaScripts in content/assets/javascripts/all.js
and import additional (S)CSS files in content/assets/stylesheets/main.scss.
The Compass configuration file is in
compass/config.rb.
There is a custom command to simplify the creation of a blog post:
nanoc create-post Title of my wonderful post
By default, this command creates a file with .mmd suffix (MultiMarkdown)
in the content/blog/posts folder.
Pass -m if you want just a Markdown file (with .md suffix).
Finally, there is a custom :external filter that allows you to pass content to
an external program. Such program must be able to read its input from STDIN and
send its output to STDOUT. For example, if you have installed
htmlcompressor, you can have your
pages minified by adding a filter rule similar to the following:
filter :external,
:exec => 'htmlcompressor',
:opts => %w( --compress-css )
The template is configured to publish your site on Github pages using the command:
nanoc deploy
You may change the remote and the branch from origin and gh-pages, respectively,
to something else (remote can be the name or the URI of a repository).