Config file

.rubocop.yml

@@ -47,6 +47,23 @@ TrailingComma:
 Style/SpecialGlobalVars:
   Enabled: false
 
+# For lambdas nested within certain expressions, this rule forces either ugly
+# parens or curly braces that violate the "do/end for multiline blocks" rule.
+Lambda:
+  Enabled: false
+
+# Disallowing indented "when" clauses destroys readability when using the
+# single-line "when/then" style.
+CaseIndentation:
+  Enabled: false
+
+# These are both subjective judgements that depend on the situation, and are
+# not appropriate as absolute rules.
+GuardClause:
+  Enabled: false
+Next:
+  Enabled: false
+
 #- Jazzy specs -----------------------------------------------------------#
 
 # Allow for `should.match /regexp/`.

CHANGELOG.md

@@ -11,6 +11,11 @@
   automatically hyperlinked to their reference.  
   [JP Simard](https://github.com/jpsim)
 
+* Jazzy can now read options from a configuration file. The command line
+  provides comprehensive help for available options via `jazzy -h config`.
+  [pcantrell](https://github.com/pcantrell)
+  [310](https://github.com/realm/jazzy/pull/310)
+
 * Render special list items (e.g. Throws, See, etc.). See
   http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/ for
   a complete list.  

README.md

@@ -33,6 +33,8 @@ To install jazzy, run `[sudo] gem install jazzy` from your command line.
 Run `jazzy` from your command line. Run `jazzy -h` for a list of additional
 options.
 
+You can set options for your project’s documentation in a configuration file, `.jazzy.yaml` by default. For a detailed explanation and an exhaustive list of all available options, run `jazzy --help config`.
+
 ### Troubleshooting
 
 #### Only extensions are listed in the documentation.