4
4
in JavaScript. It exposes multiple interfaces for users:
5
5
6
6
* with ` npm i -g documentation ` , it provides a binary for command-line usage
7
- * install ` documentation ` with ` npm ` to use the node-facing interace
7
+ * install ` documentation ` with ` npm ` to use the node-facing interface
8
8
9
9
` documentation ` runs in [ node.js] ( https://nodejs.org/ ) but supports JavaScript
10
10
that runs in _ any environment_ . You can use it to document browser libraries,
@@ -51,7 +51,7 @@ documentation.
51
51
* ` documentation ` can generate multiple formats. When you create a
52
52
website, ` documentation ` can take your documentation and generate
53
53
beautiful HTML output.
54
- * The JSDoc syntax exposes a powerful, standardized type syntax to, for example,
54
+ * The JSDoc syntax exposes a powerful, standardized type syntax to, for example,
55
55
express parameter types like 'an array of strings'.
56
56
as ` Array<String> ` , and to support custom object types with inter-linking
57
57
* The [ eslint valid-jsdoc rule] ( http://eslint.org/docs/rules/valid-jsdoc.html )
@@ -70,7 +70,7 @@ that file uses `require` or `import` to include other source files,
70
70
those source files will be documented too.
71
71
72
72
You can customize this behavior by specifying the ` --shallow ` command-line
73
- option. With ` --shallow ` specified, dependendencies aren't followed: documentation.js
73
+ option. With ` --shallow ` specified, dependencies aren't followed: documentation.js
74
74
processes only those files you explicitly name.
75
75
76
76
If you're using ES modules, you enable the option ` --document-exported ` to automatically
0 commit comments