...
- 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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
"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; |
...
- Blank horizontal lines are most of the time automatically managed by the wiki software formatting templates. Unless for a good reason, type your text, paragraph or headers, without manually added blank lines.
- Use a single space to separate sentences in the same paragraph (i.e. after period marks).
- Avoid using multiple blank lines to space out paragraphs or sections.
- Separate list characters from their items with a space.
- Individual list items cannot be separated by blank lines, otherwise the wiki parser will start a new list for each item.
- Separate special blocks (lists, code blocks, note, tip, warning etc.) from normal text with an empty line.
Status
...
You may see sometimes some color blocks containing INCOMPLETE (yellow)or TO WRITE (red). These markers are Status
links
...
Internal links
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.
- Use the Search or Recently viewed menu to link to a wiki page.
- Use the Web Link menu to link a web page
- Use the Advanced menu to link and #Anchor or a Heading of a page. Example for a heading of a page
Link : My Page Name#My Section
External links
On a page, use an external link the first time you introduce a term that need explanations or more details.This link can point to any article, Wikipedia entry or documentation which would be too long to insert in the page.
...
Please find on this page all the links to the needed resources to produce beautiful pages.