Commit Graph

95 Commits

Author SHA1 Message Date
Jason Swails
be8d639057 Fix typo in README (#300) 2020-07-30 10:49:19 -04:00
Khosrow Moossavi
39d84b62eb Upgrade actions stages (#299)
* Upgrade actions stages

* upgrade to go 1.14.6
2020-07-27 19:18:56 -04:00
Khosrow Moossavi
f71c2a360c docs: Overall improvements to documentation (#293) 2020-07-16 21:24:24 -04:00
Khosrow Moossavi
67a983b10f Release version v0.10.0-rc.1 2020-07-13 22:13:21 -04:00
Khosrow Moossavi
38a86cbdc5 feat: Build and push docker image (#289) 2020-07-11 19:36:55 -04:00
Khosrow Moossavi
dfeaaecdc4 Migrate to github.com/terraform-docs org (#288)
* Migrate to github.com/terraform-docs org

* remove codecov token

* update maintenance notice in README
2020-07-06 19:43:25 -04:00
Ryan King
57de612e29 fix 'doccs' typo (#279)
s/doccs/docs/
2020-06-24 11:54:05 -04:00
Khosrow Moossavi
b397b7d46b feat: Add support for TOML renderer (#197)
* Add support for TOML renderer

* Add kind:formatter to toml command

* update docs

* adjust tests after merge

* fix after merge

* adjust tests after merge

* update docs

* remove vendor leftovers

* update doc

* update tests
2020-05-14 12:41:21 -04:00
Rubén del Campo
37375db283 feat: Add support for AsciiDoc renderer (#241)
* Implement AsciiDoc renderer

* Add missing tests to maintain expected code coverage

* Keep alphabetical order

* Refactor indent function (accept char argument and make homogeneous for both MD and Adoc renderers)

* Force asciidoc syntax in every table column

* Remove extra NL before code blocks and add autowidth tables

* Move char argument after settings in indent function

* Implement new factory function for asciidoc renderer

* Update asciidoc table docs

* Return empty indentation if no indent scpecified

* Prevent adding a trailing whitespace in table rows

* Change asciidoc alias to match file extension

* Update docs
2020-04-12 15:22:53 -04:00
Khosrow Moossavi
7190091d07 Release version v0.9.1 2020-04-02 17:58:05 -04:00
Khosrow Moossavi
f1bd8bea72 Release version v0.9.0 2020-03-31 16:18:26 -04:00
Khosrow Moossavi
40bd96be44 docs: Enhance automatic document generation (#227)
* Enhance automatic document generation

* update contribuor guide

* fix broken link
2020-03-29 18:17:55 -04:00
Khosrow Moossavi
9043f268ad feat: Add support for tfvars hcl and json commands (#226)
* Add support for tfvars hcl and json commands

* fix docs generation header issue

* align padding of hcl tfvars items

* add more tests

* update docs

* wording
2020-03-27 15:02:09 -04:00
Khosrow Moossavi
4964ff81c0 Fix installation typo 2020-03-12 18:20:58 -04:00
Aaron Steers
022f1dd0a9 docs: Add installation guide for Windows users (#218)
* add install guidance for Windows users

* fixed case
2020-03-12 15:56:59 -04:00
Khosrow Moossavi
a04ccc2555 Upgrade go to 1.14 (#213) 2020-03-03 16:25:19 -05:00
Khosrow Moossavi
5a05b95349 Add codecov report and badge (#209) 2020-02-28 10:44:14 -05:00
Khosrow Moossavi
b716a25811 feat: Add support for XML renderer (#198)
* Add support for XML renderer

* formatting

* update docs
2020-02-26 14:44:50 -05:00
Khosrow Moossavi
54ab7f9bbb docs: Auto generate formats document from examples (#192)
* Auto generate formats document from examples

* fix lint issues
2020-02-10 20:53:57 -05:00
Martyn Ranyard
dafa2e84f7 Link formats documentation in README (#181)
Co-authored-by: Khosrow Moossavi <khos2ow@gmail.com>
2020-02-10 13:57:22 -05:00
Khosrow Moossavi
42ad476a37 feat: Add support for YAML renderer (#189) 2020-02-03 20:13:10 -05:00
Khosrow Moossavi
3fff66d4ea Release version v0.8.2 2020-02-03 13:33:24 -05:00
Khosrow Moossavi
a214ad2586 Release version v0.8.1 2020-01-21 10:48:26 -05:00
Khosrow Moossavi
143e47dbef Fix release scripts (#175) 2020-01-20 17:20:36 -05:00
Khosrow Moossavi
6a8689d625 Release version v0.8.0 2020-01-17 14:44:26 -05:00
chenrui
2e6493c8bb feat: Bump golang to latest v1.13 (#133) 2019-12-20 16:35:11 -05:00
Khosrow Moossavi
89dc73957f Update badges in README 2019-12-13 16:36:39 -05:00
Khosrow Moossavi
e8655acc60 Release version v0.7.0 2019-12-12 16:34:41 -05:00
Khosrow Moossavi
c5b506f64e Update Installation and Code Completion in README 2019-12-11 16:44:45 -05:00
Khosrow Moossavi
5faf591544 Use Cobra CLI instead of docopt (#116) 2019-07-05 16:16:11 +02:00
Martin Etmajer
baac090cb9 Complete development requirements documentation. 2019-01-23 12:35:27 +01:00
Khosrow Moossavi
f32b321fc0 Replace dep with Go Modules (#100) 2019-01-23 11:55:54 +01:00
Martin Etmajer
57c27b92d0 Capitalize headings in documentation. 2018-12-03 09:01:35 +01:00
Khosrow Moossavi
f52784bd81 Fix Markdown lint errors and enhancement in README (#94)
* MD014 - Dollar signs used before commands without showing output

* MD033 - Inline HTML

* Add table of contents
2018-12-02 22:15:21 +01:00
Martin Etmajer
41b7727106 Update project documentation. 2018-12-02 20:30:17 +01:00
Martin Etmajer
fbcea19636 Capitalize the word 'markdown' in documentation. 2018-12-02 15:50:19 +01:00
Khosrow Moossavi
6534330b66 Add support for rendering Markdown documents (#81)
* Add support for rendering Markdown content

* Change --markdown-table and --markdown-document flags to corresponding subcommands

* Use import aliases for 'markdown' packages

* Keep functions in alphabetic order

* Remove redundant 'showDefault' variable

* Prettify list and map for 'markdown document' view

* Rename package from 'content' to 'document'

* Fix some wording in README and Usage text

* Improve documentation.

* Improve wording around inputs and outputs.

* Improve code readability and maintainability.

* Rename misnamed function 'printMarkdown' to 'printInput'.

* Remove remark 'optional' from markdown types documentation.

* Refactor fenced code block generation.

* Add JSON language specifier to fenced code block generation.

* Add Markdown document sanitising to soothe linters.

* Minor code beautification.

* Fix gometalinter error
2018-12-02 09:22:57 +01:00
Stuart Auld
c22e40fbd3 Add support to print Markdown files with underscored variable names escaped (#48) (#63) 2018-10-24 12:36:25 +02:00
Martin Etmajer
c94a100ef1 Add CircleCI badge. 2018-10-10 19:41:04 +02:00
Stuart Auld
0b468e30db Add sort by "required" and then name (#43) 2018-10-09 10:29:09 +02:00
Martin Etmajer
721386d799 Add option --with-aggregate-type-defaults to enable printing of default values for types 'list' and 'map'. (#53) 2018-09-23 14:47:00 +02:00
Martin Etmajer
5584170a2c Add option --no-sort to omit sorted rendering of inputs and outputs. (#61) 2018-09-23 00:14:45 +02:00
Martin Etmajer
a1c7308818 Refactor package 'print' for better modularity. (#59) 2018-09-22 19:37:21 +02:00
Martin Etmajer
f0ef879cb4 Update documentation and license to reflect the terraform-docs authors. 2018-09-21 08:49:52 +02:00
Martin Etmajer
8c87c818a2 Update documentation. 2018-09-21 08:49:52 +02:00