Skip to content

Commit

Permalink
Merge pull request #15 from jousch/documentation/yamllint-local
Browse files Browse the repository at this point in the history
[DOCUMENTATION] Add infos about tidy/format the exported yaml files
  • Loading branch information
Michiel Roos authored Oct 24, 2016
2 parents 23fe20e + ffdfb3d commit 6bc67cf
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Documentation/CommandReference/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,3 +287,15 @@ Options



Tidy/Format the exported yaml
=============================

You can tidy exported yaml files using an online tool like: http://www.yamllint.com/.
If you do not trust online tools, you can also convert it locally with e.g. the following npm packages: ``js-yaml`` and ``json2yaml``.

.. code-block:: bash
# Install dependencies globally (node.js https://nodejs.org/en/ must be installed in order to run the following command)
npm install -g js-yaml json2yaml
# Example: reformatting exported be_groups.yml to be_groups.formatted.yml
js-yaml be_groups.yml | json2yaml > ./be_groups.formatted.yml

0 comments on commit 6bc67cf

Please sign in to comment.