The documentation for nanoc is organised in a couple of chapters, which you can see in the sidebar. The documentation is written with the intention to be read in-order, from the first chapter to the last.
The first chapter, Introduction, explains what nanoc is and what it does. The Installation and Getting Started chapters detail how to start using nanoc. The Basic Concepts, Advanced Concepts and Guides chapters explain all of nanoc’s functionality in detail and provide useful tips and tricks for getting the most out of nanoc. The Glossary is useful if you don’t know what a certain term means, and the FAQ can come in handy if you’re stuck on a certain problem. Lastly, if you’re a nanoc 2.x user and you’re looking to update your site to nanoc 3.x, the Migration guide will come in handy.
When you’re stuck with a question or a problem the documentation doesn’t solve, considering posting to the discussion group or joining the IRC channel. We’ll get it sorted out in no time. Check out the Community page for details.
The nanoc documentation uses a few conventions for markup:
Monospaced text is used for code snippets.The documentation also contains quite a few blocks of code snippets. These are marked up like this:
class Lorem::Ipsum
def dolor
[ :foo, "sit amet, consectetur adipisicing elit", 123 ]
end
endPieces of terminal input/output are marked up in a similar way. Note that the prompt is always included, but should never be typed. Here’s an example:
some-dir% echo "hello" && cd other-dir hello other-dir%