Skip to content

Commit 89fd188

Browse files
authored
docs: Include --github flag in README (#1364)
1 parent 70ad529 commit 89fd188

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ Usage:
5656
# generate markdown docs for index.js and files it references
5757
documentation build index.js -f md
5858

59-
# generate html docs for all files in src
60-
documentation build src/** -f html -o docs
59+
# generate html docs for all files in src, and include links to source files in github
60+
documentation build src/** -f html --github -o docs
6161

6262
# document index.js, ignoring any files it requires or imports
6363
documentation build index.js -f md --shallow

0 commit comments

Comments
 (0)