nanoc.yaml

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