How to use the documentation
The documentation for nanoc is organised in a couple of parts:
The Tutorial chapter is meant for first-time users of nanoc, who want to get an impression of what nanoc can do and how it’s done. After reading this part, you should be able to get a basic site up and running.
The Basics chapter describes how to use nanoc in great detail. Everything that nanoc can do, you will find in here.
The Extending nanoc chapter shows how nanoc can be extended by writing custom helpers, filters, data sources and more. Medium-sized to large projects will certainly benefit from this chapter.
The Guides show in detail how specific things can be achieved with nanoc. Even if they are not relevant to you, they may be an interesting read in order to get a better idea of what the nanoc way is.
The Reference contains the reference documentation for filters, helpers and commands that nanoc supports out of the box.
The Troubleshooting section describes some frequent error messages, what causes them and how to solve them.
The Glossary is a collection of terms that you may stumble upon while using nanoc or reading its documentation. If you don’t understand a term, go here!
The API documentation contains the documentation of nanoc’s internals. This is quite useful if you want to contribute to nanoc or extend it.
When you’re stuck with a question or a problem the documentation doesn’t solve, considering posting to the discussion group or joining the nanoc IRC channel. We’ll get it sorted out in no time. Check out the Community page for details.