Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorConnor Shea <connor.james.shea@gmail.com>2016-10-06 08:40:24 +0300
committerConnor Shea <connor.james.shea@gmail.com>2016-10-06 08:40:24 +0300
commit764ca757a5584314c2a5515140b523f52c9d6997 (patch)
tree585ba3f994ca8392b5ee4f2097eda06990e0728c /nanoc.yaml
Init repo.
Diffstat (limited to 'nanoc.yaml')
-rw-r--r--nanoc.yaml90
1 files changed, 90 insertions, 0 deletions
diff --git a/nanoc.yaml b/nanoc.yaml
new file mode 100644
index 000000000..b7dd1b36f
--- /dev/null
+++ b/nanoc.yaml
@@ -0,0 +1,90 @@
+# The syntax to use for patterns in the Rules file. Can be either `"glob"`
+# (default) or `"legacy"`. The former will enable glob patterns, which behave
+# like Ruby’s File.fnmatch. The latter will enable Nanoc 3.x-style patterns.
+string_pattern_type: glob
+
+# A list of file extensions that Nanoc will consider to be textual rather than
+# binary. If an item with an extension not in this list is found, the file
+# will be considered as binary.
+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' ]
+
+# The path to the directory where all generated files will be written to. This
+# can be an absolute path starting with a slash, but it can also be path
+# relative to the site directory.
+output_dir: output
+
+# A list of index filenames, i.e. names of files that will be served by a web
+# server when a directory is requested. Usually, index files are named
+# “index.html”, but depending on the web server, this may be something else,
+# such as “default.htm”. This list is used by Nanoc to generate pretty URLs.
+index_filenames: [ 'index.html' ]
+
+# Whether or not to generate a diff of the compiled content when compiling a
+# site. The diff will contain the differences between the compiled content
+# before and after the last site compilation.
+enable_output_diff: false
+
+prune:
+ # Whether to automatically remove files not managed by Nanoc from the output
+ # directory.
+ auto_prune: true
+
+ # Which files and directories you want to exclude from pruning. If you version
+ # your output directory, you should probably exclude VCS directories such as
+ # .git, .svn etc.
+ exclude: [ '.git', '.hg', '.svn', 'CVS' ]
+
+# The data sources where Nanoc loads its data from. This is an array of
+# hashes; each array element represents a single data source. By default,
+# there is only a single data source that reads data from the “content/” and
+# “layout/” directories in the site directory.
+data_sources:
+ -
+ # The type is the identifier of the data source.
+ type: filesystem
+
+ # The path where items should be mounted (comparable to mount points in
+ # Unix-like systems). This is “/” by default, meaning that items will have
+ # “/” prefixed to their identifiers. If the items root were “/en/”
+ # instead, an item at content/about.html would have an identifier of
+ # “/en/about/” instead of just “/about/”.
+ items_root: /
+
+ # The path where layouts should be mounted. The layouts root behaves the
+ # same as the items root, but applies to layouts rather than items.
+ layouts_root: /
+
+ # The encoding to use for input files. If your input files are not in
+ # UTF-8 (which they should be!), change this.
+ encoding: utf-8
+
+ # The kind of identifier to use for items and layouts. The default is
+ # “full”, meaning that identifiers include file extensions. This can also
+ # be “legacy”, primarily used by older Nanoc sites.
+ identifier_type: full
+
+# Configuration for the “check” command, which run unit tests on the site.
+checks:
+ # Configuration for the “internal_links” checker, which checks whether all
+ # internal links are valid.
+ internal_links:
+ # A list of patterns, specified as regular expressions, to exclude from the check.
+ # If an internal link matches this pattern, the validity check will be skipped.
+ # E.g.:
+ # exclude: ['^/server_status']
+ exclude: []
+
+ # Configuration for the “external_links” checker, which checks whether all
+ # external links are valid.
+ external_links:
+ # A list of patterns, specified as regular expressions, to exclude from the check.
+ # If an external link matches this pattern, the validity check will be skipped.
+ # E.g.:
+ # exclude: ['^http://example.com$']
+ exclude: []
+
+ # A list of file patterns, specified as regular expressions, to exclude from the check.
+ # If a file matches this pattern, the links from this file will not be checked.
+ # E.g.:
+ # exclude_files: ['blog/page']
+ exclude_files: []