Skip to content
Browse files

Update cli args help

  • Loading branch information...
1 parent dc67866 commit 0362a1c9e765fb3e77765d3d9277eb1bd85a818e @ixti ixti committed Jul 2, 2012
Showing with 15 additions and 12 deletions.
  1. +8 −6 README.md
  2. +5 −5 lib/ndoc/cli.js
  3. +2 −1 lib/ndoc/plugins/renderers/html.js
View
14 README.md
@@ -43,10 +43,10 @@ If not - try [nvm](https://github.com/creationix/nvm).
--use PLUGIN Load custom plugin.
-r RENDERER, --render RENDERER Documentation renderer (html, json). More
can be added by custom plugins.
- --link-format FORMAT View sources link format. You can use
- `{file}` and `{line}` and any of `{package.
- *}` variables for interpolation. DEFAULT:
- `{file}#L{line}`
+ --link-format FORMAT View sources link (no links by default)
+ format. You can use `{file}` and `{line}`
+ and any of `{package.*}` variables for
+ interpolation.
-t TEMPLATE, --title TEMPLATE Documentation title template. You can use
any of `{package.*}` variables for
interpolation. DEFAULT: `{package.name}
@@ -57,11 +57,13 @@ If not - try [nvm](https://github.com/creationix/nvm).
--package PACKAGE Read specified package.json FILE. When not
specified, read ./package.json if such file
exists.
- --index FILE Index file
+ --index FILE Index file (with introduction text), e.g.
+ README.md file.
--gh-ribbon URL Add "Fork me on GitHub" ribbon with given
URL. You can use any of `{package.*}`
variables for interpolation.
- --broken-links ACTION What to do if broken link occurred
+ --broken-links ACTION What to do if broken link occurred (show,
+ hide, throw). DEFAULT: `show`.
--noenv Ignore .ndocrc
View
10 lib/ndoc/cli.js
@@ -124,12 +124,12 @@ cli.addArgument(['-r', '--render'], {
cli.addArgument(['--link-format'], {
- help: 'View sources link format. You can use `{file}` and `{line}` ' +
- 'and any of `{package.*}` variables for interpolation. ' +
- 'DEFAULT: `{file}#L{line}`',
+ help: 'View sources link (no links by default) format. You can use ' +
+ '`{file}` and `{line}` and any of `{package.*}` variables ' +
+ 'for interpolation.',
dest: 'linkFormat',
metavar: 'FORMAT',
- defaultValue: '{file}#L{line}'
+ defaultValue: null
});
@@ -164,7 +164,7 @@ cli.addArgument(['--package'], {
cli.addArgument(['--index'], {
- help: 'Index file',
+ help: 'Index file (with introduction text), e.g. README.md file.',
metavar: 'FILE',
action: 'store+readFile',
defaultValue: ''
View
3 lib/ndoc/plugins/renderers/html.js
@@ -275,7 +275,8 @@ module.exports = function html(NDoc) {
NDoc.cli.addArgument(['--broken-links'], {
dest: 'brokenLinks',
- help: 'What to do if broken link occurred',
+ help: 'What to do if broken link occurred (show, hide, throw). ' +
+ 'DEFAULT: `show`.',
choices: ['show', 'hide', 'throw'],
metavar: 'ACTION',
defaultValue: 'show'

0 comments on commit 0362a1c

Please sign in to comment.
Something went wrong with that request. Please try again.