Nanoc 4 static website template, packed with features.
Static folder: /static with content that will be blindly copied to the root.
SASS compiler is enabled on *.scss. CSS files are simply copied as they are.
Resulting CSS files are minified.
TODO: Ignore partial SASS files (starting with _).
We use kramdown markdown compiler, as it is very cool!
Links in MD files can be Markdown links (*.md), i.e. can reference other MD file.
On output generation, these links will be changed to *.html.
This way your MD files on e.g. github will be linked; but also the generated site will be linked as well.
MD files are ruby-preprocessed, too!
Generated HTML files are compressed.
There is ruby function h() that prints HTML safe output.
Collection is an ordered set of items of the same kind. For example, it may
be collection of short stories.
Collections are built for every root folder (i.e. only level-1 folders)
which items (i.e. MD files) has frontmatter attribute date defined.
Collection name is set by the name of the kind, if exist. If missing,
collection name is equal to root folder name.
Since they are ordered, each collection item has prev/next link with ids of previous and next items.
Tags are defined in tags attribute that is an array of strings.
Each tag has it's own tags page under /tags/ folder.
Default nanoc Blog extension is enabled. Blogs are stored in the /blogs/
folder. Each blog entry is in one subfolder and it's kind will be automatically
set to article. Root page contains the list of all blogs.
Blogs are ordered by date/time, similar to collections.
Each folder may contain additional meta-data stored in *.yaml files.
Each metadata is automatically binded into all the items in the same folder.
You get the parsed metadata as: @item[yaml_name].
This can be used, for example, to define a submenu.
Just put JSON files anywere. Each JSON file will be loaded in global variable
$jsondata under the key that is equal to json file name (w/o extension), for
example: <%= $jsondata['j1'] %>.
Be sure not to have the same json file name in different folders.
There is sitemap generator as well.
It is defined in htaccess.txt. It generates .htaccess.
Lorem library is availiable for creating dummy content.
Defines name of the collection. If not specified, kind will is equal to first directory name.
Root items does not have implicit kind. Kind can be specified in Rules, too.
Defines article timestamp. If not specified, files timestamp will be used. Both metadata are identical.
Optional timestamp of last update.
bundle install
bundle update
bundle exec nanoc compile
bundle exec guard
bundle exec nanoc view