diff --git a/README.md b/README.md index 6106acd9a..b0641d01a 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,13 @@ npm script: The plugin exposes the following additional arguments: * `--mdFlavour`
- * `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`
Suppress source file linking from output. + * `--mdSourceRepo`
The source repo to use for source file linking. Will be ignored on github flavoured projects.
For bitbucket use: `https://bitbucket.org/owner/repository_name`.