Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add note about heading

...

  • Headings should start from level 2, because level 1 is reserved for article titles.
  • Do not skip levels when making subsections, so a subsection of a level 2 needs a level 3 heading and so on.
  • Avoid using links in headings because they break style consistency and do not stand out well enough.

    Note

    Please avoid to write any text deeper than heading 4. Going below may lost the reader with too many sub-levels.

Code formatting

When inserting inline code, use monospace format. Example:

...

For large code block, insert the code block macro: choose your syntax, check theĀ CollapsibleĀ option and use the Midnight DJango theme.

Code Block
languagejs
themeMidnight
collapsetrue
"use strict";

// require npm packages
const bl = require('bl');
const https = require('https');

// require modules
const exportAsCsv = require('./exportAsCsv.js');
const address = require('./settings.js').address;

...