Home Original page

fix(markdown): Start headings in Markdown at h2 (#644) · documentationjs/documentation@2ae5d8f

11

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

223-

# build

3+

## build

4455

Generate JavaScript documentation as a list of parsed JSDoc

66

comments, given a root file as a path.

@@ -54,7 +54,7 @@ documentation.build(['index.js'], {

54545555

Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)** calls callback

565657-

# buildSync

57+

## buildSync

58585959

Generate JavaScript documentation given a list of inputs. This internal

6060

method does not support require-following and it returns its results

@@ -100,7 +100,7 @@ var results = documentation.buildSync(['index.js']);

100100101101

Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** list of results

102102103-

# lint

103+

## lint

104104105105

Lint files for non-standard or incorrect documentation

106106

information, returning a potentially-empty string

@@ -145,14 +145,14 @@ documentation.lint('file.js', {}, function (err, lintOutput) {

145145146146

Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)** calls callback

147147148-

# formats

148+

## formats

149149150150

Documentation's formats are modular methods that take comments

151151

and options as input and call a callback with writable objects,

152152

like stringified JSON, markdown strings, or Vinyl objects for HTML

153153

output.

154154155-

# formats.html

155+

## formats.html

156156157157

Formats documentation as HTML.

158158

@@ -179,7 +179,7 @@ documentation.build(['index.js'], {}, function (err, res) {

179179180180

Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)** Calls callback.

181181182-

# formats.markdown

182+

## formats.markdown

183183184184

Formats documentation as

185185

[Markdown](http://daringfireball.net/projects/markdown/).

@@ -206,7 +206,7 @@ documentation.build(['index.js'], {}, function (err, res) {

206206207207

Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)** calls callback

208208209-

# formats.json

209+

## formats.json

210210211211

Formats documentation as a JSON string.

212212