Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Apr 2, 2018
1 parent 5361720 commit 229d661
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@ npm script:
The plugin exposes the following additional arguments:

* `--mdFlavour<github|bitbucket|gitbook>`<br />
* `github` - default output.
* `bitbucket` - renders markdown to support bitbucket anchor linking and more.
* `gitbook` - adds SUMMARY.md file to generate a book's table of contents.
* `github`: Default output.
* `bitbucket`: Renders markdown to support bitbucket anchor linking and more.
* `gitbook`: Adds SUMMARY.md file to generate a book's table of contents.

* `--mdHideSources`<br />
Suppress source file linking from output.

* `--mdSourceRepo<path.to.repo>`<br />
The source repo to use for source file linking. Will be ignored on github flavoured projects.<br />
For bitbucket use: `https://bitbucket.org/owner/repository_name`.<br />
Expand Down

0 comments on commit 229d661

Please sign in to comment.