File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change 1+ # Configuring documentation.js
2+
3+ Configuration is a completely optional step for generating documentation
4+ with documentation.js. The tool is designed to accept any JSDoc-annotated
5+ source code and automatically generate output.
6+
7+ Configuration - a ` documentation.yml ` file - will accomplish two goals:
8+
9+ * Organization: you can put top level documentation in order of importance
10+ * Narration: you can add narrative sections - plain English writing - in
11+ between autogenerated API documentation.
12+
13+ Here's how ` documentation.yml ` works:
14+
15+ ``` yml
16+ toc :
17+ - Map
18+ - name : Geography
19+ description : |
20+ These are Mapbox GL JS's ways of representing locations
21+ and areas on the sphere.
22+ - LngLat
23+ - LngLatBounds
24+ ` ` `
25+
26+ This puts the top level API documentation for the ` Map`, `LngLat`, and `LngLatBounds`
27+ items in the given order, and inserts a narrative item titled `Geography`
28+ after the section on maps. The `description` property of that narrative item
29+ is interpreted as Markdown.
You can’t perform that action at this time.
0 commit comments