Versions Compared

Key

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

Status
colourBlue
titleTO BE REVIEWED

Panel
titleColor#f8f8f8
titleBGColor#348AC7
borderStylesolid
titleContent

Table of Contents

...

  • 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;

...

You may see sometimes some color blocks containing INCOMPLETE (yellow)or TO WRITE (red). These markers are Status for the whole page or only the section they belong to.

When you see

Status
colourRed
titleTO WRITE
, this is obviously to notice the section or page has to be written.

The

Status
colourYellow
titleINCOMPLETE
one signal a section or page which still need more details.

If you add content to section or page with one of this status, and think the status has changed, please remove this little icon to show the reader the section/page is now complete.

...

You can create a link to a page/heading from the wiki, or any external web page. To do this, click the "Insert link" icon on the menu.

...