mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
4c66fb14c7
Adds a new option, `--no-markdown-toc`, to turn off Table of Contents generation. Table of contents are now generated by default with markdown output, including through the `readme` command. Fixes https://github.com/documentationjs/documentation/issues/220
245 lines
5.3 KiB
JSON
245 lines
5.3 KiB
JSON
{
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "html",
|
|
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
|
|
},
|
|
{
|
|
"depth": 3,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Table of Contents"
|
|
}
|
|
],
|
|
"data": {
|
|
"id": "table-of-contents",
|
|
"htmlAttributes": {
|
|
"id": "table-of-contents"
|
|
},
|
|
"hProperties": {
|
|
"id": "table-of-contents"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "list",
|
|
"ordered": false,
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"loose": false,
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "link",
|
|
"title": null,
|
|
"url": "#foo",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "foo"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 2,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "foo"
|
|
}
|
|
],
|
|
"data": {
|
|
"id": "foo",
|
|
"htmlAttributes": {
|
|
"id": "foo"
|
|
},
|
|
"hProperties": {
|
|
"id": "foo"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This function returns the number one.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 38,
|
|
"offset": 37
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 38,
|
|
"offset": 37
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Examples"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "emphasis",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "demonstrates how to run foo",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"lang": "javascript",
|
|
"type": "code",
|
|
"value": "foo(1);"
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Returns "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "numberone",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
} |