From 948399f163a1781f6febddba0b6ece9a67a6cc44 Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Fri, 15 Oct 2021 09:59:08 +1100 Subject: [PATCH] Man page wip --- pkg/yqlib/doc/headers/Main.md | 4 +++- scripts/genman.sh | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/pkg/yqlib/doc/headers/Main.md b/pkg/yqlib/doc/headers/Main.md index fcd0fc58..67b17f90 100644 --- a/pkg/yqlib/doc/headers/Main.md +++ b/pkg/yqlib/doc/headers/Main.md @@ -1,9 +1,11 @@ # NAME - *yq* - Command-line yaml processor + *yq* is a portable command-line YAML processor (https://github.com/mikefarah/yq/) # SYNOPSIS a lightweight and portable command-line YAML processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml files as well as json. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously. +This documentation is also available at https://mikefarah.gitbook.io/yq/. + # QUICK GUIDE ## Read a value: diff --git a/scripts/genman.sh b/scripts/genman.sh index 6eee7564..93a3bdc5 100755 --- a/scripts/genman.sh +++ b/scripts/genman.sh @@ -18,4 +18,4 @@ for f in ./pkg/yqlib/doc/*.md; do done -pandoc --variable=title:"yq" --variable=author:"Mike Farah" --standalone --to man man.md -o yq.1 \ No newline at end of file +pandoc --variable=title:"yq" --variable=section:"1" --variable=author:"Mike Farah" --standalone --to man man.md -o yq.1 \ No newline at end of file