Prerequisites

Put an x into the box(es) that apply:

• This pull request fixes a bug.
• This pull request adds a feature.
• This pull request enhances existing functionality.
• This pull request introduces breaking change.

For more information, see the Contributing Guide.

Description

This PR adds support for reading configuration from file. There's a new flag added for this -c, --config which accepts name of the config file (default to .terraform-docs.yml).

Example .terraform-docs.yml:

formatter: markdown table
header-from: doc.txt
sections:
  hide:
    - inputs
    - outputs
settings:
  indent: 4
  required: false

Example Usage:

terraform-docs ./example/ # this will read the config above
                          # generate output of Markdown Table
                          # Inputs and Outputs will be hidden
                          # Indention will be 4
                          # Required column won't be shown

Issues Resolved

n/a

Checklist

Put an x into all boxes that apply:

• I have read the Contributing Guidelines.

Tests

• I have added tests to cover my changes.
• All tests pass when I run make test.

Documentation

• My change requires a change to the documentation.
• I have updated the documentation accordingly.

Code Style

• My code follows the code style of this project.