nanoc.yaml 4.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. # The syntax to use for patterns in the Rules file. Can be either `"glob"`
  2. # (default) or `"legacy"`. The former will enable glob patterns, which behave
  3. # like Ruby’s File.fnmatch. The latter will enable Nanoc 3.x-style patterns.
  4. string_pattern_type: glob
  5. # A list of file extensions that Nanoc will consider to be textual rather than
  6. # binary. If an item with an extension not in this list is found, the file
  7. # will be considered as binary.
  8. text_extensions: [ 'adoc', 'asciidoc', 'atom', 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'ms', 'mustache', 'php', 'rb', 'rdoc', 'sass', 'scss', 'slim', 'txt', 'xhtml', 'xml' ]
  9. # The path to the directory where all generated files will be written to. This
  10. # can be an absolute path starting with a slash, but it can also be path
  11. # relative to the site directory.
  12. output_dir: output
  13. # A list of index filenames, i.e. names of files that will be served by a web
  14. # server when a directory is requested. Usually, index files are named
  15. # “index.html”, but depending on the web server, this may be something else,
  16. # such as “default.htm”. This list is used by Nanoc to generate pretty URLs.
  17. index_filenames: [ 'index.html' ]
  18. # Whether or not to generate a diff of the compiled content when compiling a
  19. # site. The diff will contain the differences between the compiled content
  20. # before and after the last site compilation.
  21. enable_output_diff: false
  22. prune:
  23. # Whether to automatically remove files not managed by Nanoc from the output
  24. # directory.
  25. auto_prune: true
  26. # Which files and directories you want to exclude from pruning. If you version
  27. # your output directory, you should probably exclude VCS directories such as
  28. # .git, .svn etc.
  29. exclude: [ '.git', '.hg', '.svn', 'CVS' ]
  30. # The data sources where Nanoc loads its data from. This is an array of
  31. # hashes; each array element represents a single data source. By default,
  32. # there is only a single data source that reads data from the “content/” and
  33. # “layout/” directories in the site directory.
  34. data_sources:
  35. -
  36. # The type is the identifier of the data source.
  37. type: filesystem
  38. # The path where items should be mounted (comparable to mount points in
  39. # Unix-like systems). This is “/” by default, meaning that items will have
  40. # “/” prefixed to their identifiers. If the items root were “/en/”
  41. # instead, an item at content/about.html would have an identifier of
  42. # “/en/about/” instead of just “/about/”.
  43. items_root: /
  44. # The path where layouts should be mounted. The layouts root behaves the
  45. # same as the items root, but applies to layouts rather than items.
  46. layouts_root: /
  47. # The encoding to use for input files. If your input files are not in
  48. # UTF-8 (which they should be!), change this.
  49. encoding: utf-8
  50. # The kind of identifier to use for items and layouts. The default is
  51. # “full”, meaning that identifiers include file extensions. This can also
  52. # be “legacy”, primarily used by older Nanoc sites.
  53. identifier_type: full
  54. # Configuration for the “check” command, which run unit tests on the site.
  55. checks:
  56. # Configuration for the “internal_links” checker, which checks whether all
  57. # internal links are valid.
  58. internal_links:
  59. # A list of patterns, specified as regular expressions, to exclude from the check.
  60. # If an internal link matches this pattern, the validity check will be skipped.
  61. # E.g.:
  62. # exclude: ['^/server_status']
  63. exclude: []
  64. # Configuration for the “external_links” checker, which checks whether all
  65. # external links are valid.
  66. external_links:
  67. # A list of patterns, specified as regular expressions, to exclude from the check.
  68. # If an external link matches this pattern, the validity check will be skipped.
  69. # E.g.:
  70. # exclude: ['^http://example.com$']
  71. exclude: []
  72. # A list of file patterns, specified as regular expressions, to exclude from the check.
  73. # If a file matches this pattern, the links from this file will not be checked.
  74. # E.g.:
  75. # exclude_files: ['blog/page']
  76. exclude_files: []