{ "source": "doc/api/documentation.markdown", "miscs": [ { "textRaw": "About this Documentation", "name": "About this Documentation", "type": "misc", "desc": "
The goal of this documentation is to comprehensively explain the Node.js\nAPI, both from a reference as well as a conceptual point of view. Each\nsection describes a built-in module or high-level concept.\n\n
\nWhere appropriate, property types, method arguments, and the arguments\nprovided to event handlers are detailed in a list underneath the topic\nheading.\n\n
\nEvery .html
document has a corresponding .json
document presenting\nthe same information in a structured manner. This feature is\nexperimental, and added for the benefit of IDEs and other utilities that\nwish to do programmatic things with the documentation.\n\n
Every .html
and .json
file is generated based on the corresponding\n.markdown
file in the doc/api/
folder in node's source tree. The\ndocumentation is generated using the tools/doc/generate.js
program.\nThe HTML template is located at doc/template.html
.\n\n
Throughout the documentation, you will see indications of a section's\nstability. The Node.js API is still somewhat changing, and as it\nmatures, certain parts are more reliable than others. Some are so\nproven, and so relied upon, that they are unlikely to ever change at\nall. Others are brand new and experimental, or known to be hazardous\nand in the process of being redesigned.\n\n
\nThe notices look like this:\n\n
\nStability: 1 Experimental
\nThe stability indices are as follows:\n\n
\nEvery HTML file in the markdown has a corresponding JSON file with the\nsame data.\n\n
\nThis feature is new as of node v0.6.12. It is experimental.\n
\n", "type": "misc", "displayName": "JSON Output" } ] } ] }