From a402041ae33772816532d1031e93099d7f180891 Mon Sep 17 00:00:00 2001 From: Benny Lichtner Date: Sun, 21 Mar 2021 10:05:02 -0700 Subject: [PATCH] Include --github flag in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b3cab6472..0f3aa1288 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,8 @@ Usage: # generate markdown docs for index.js and files it references documentation build index.js -f md -# generate html docs for all files in src -documentation build src/** -f html -o docs +# generate html docs for all files in src, and include links to source files in github +documentation build src/** -f html --github -o docs # document index.js, ignoring any files it requires or imports documentation build index.js -f md --shallow