Documentation style guide

The purpose of this style guide is to make sure that anyone authoring documentation writes in a clear and unified way that reflects a common style. This guide is intended to be prescriptive but not onerous and is open to community contribution and discussion.

NOTE: The current expressjs.com site may not adhere to these guidelines, but:

• The intent is to update the site to conform to them.
• New material should be conforming as much as possible.

##Headings In general, top-level headings should be h2 tags, and sub-headings should be h3, h4, and so on, hierarchically. Try to avoid having headings h5 and beyond as it generally presents too many levels and is often better to reorganize. However, if you cannot avoid, there is no strict prohibition from using them.

NOTE: The site currently uses h3 tags for top-level heads.

Formatting conventions

File names, code literals, routes

Enclose the following in <code> tags so they are rendered inline in fixed-pitch font:

• File names and directory paths; for example package.json.
• Code elements when used inline, for example object names, function calls, and the like; for example app.route().
• URLs and routes, for example http://localhose:8000 or /birds/about.

Code samples

Code samples longer than one line should be put within a +js tag to provide syntax highlighting:

  +js.
    code goes here...