Node.js documentation style guide

Table of contents

General guidelines

File naming

Text wrapping

Editor configuration

Testing documentation

Writing style

Spelling and grammar

Commas

Pronouns

Gender-neutral language

Terminology

Punctuation

Terminal punctuation

Quotation marks

Colons and semicolons

Document structure

Headings

Links

Lists

Tables

API documentation

YAML comments

Usage examples

Parameter descriptions

Code blocks

Language-aware fences

Code comments

Formatting

Escaping characters

Naming conventions

Function arguments and returns

Product and project naming

Official styling

Node.js references

Version references