Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
nanoc is a web publishing system written in Ruby. This GitHub repository is a mirror of the original Mercurial repository.
Ruby

This branch is 2203 commits ahead, 770 commits behind nanoc:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
doc
lib
tasks
test
.gitignore
.travis.yml
CONTRIBUTING.md
ChangeLog
Gemfile
Gemfile.lock
LICENSE
NEWS.md
README.md
Rakefile
nanoc.gemspec
nanoc3.gemspec

README.md

Build Status Code Climate Coverage Status

Please take a moment and donate to nanoc. A lot of time has gone into developing nanoc, and I would like to keep the current pace. Your support will ensure that nanoc will continue to improve.

nanoc

nanoc is a simple but very flexible static site generator written in Ruby. It operates on local files, and therefore does not run on the server. nanoc “compiles” the local source files into HTML (usually), by evaluating eRuby, Markdown, etc.

Note: This documentation looks best with Yardoc, not RDoc.

Requirements

Ruby 1.9.x and up.

nanoc has few dependencies. It is possible to use nanoc programmatically without any dependencies at all, but if you want to use nanoc in a proper way, you’ll likely need some dependencies:

  • The commandline frontend depends on cri.
  • Filters and helpers likely have dependencies on their own too.

If you’re developing for nanoc, such as writing custom filters or helpers, you may be interested in the development dependencies:

  • For documentation generation you’ll need yard.
  • For testing you’ll need mocha and minitest.

Installation

gem install nanoc or take a look at the installation page.

Tests

Running rake will run all the tests. To run a subset, use specific tasks, e.g. rake test:filters for running filter tests only.

Versioning

nanoc uses Semantic Versioning.

Documentation

Check out the nanoc web site!

License

nanoc is licensed under the MIT license. For details, check out the LICENSE file.

Support

You can get help in the following places:

Something went wrong with that request. Please try again.