Using Markdown documents

Using Markdown documents

Starting with v0.9.90, InfoQube handles Markdown documents.
 
To create a new Markdown:
  • Menu > File > New > New Markdown file
You can then enter text using the Markdown syntax. Whenever the document is saved (or focus is moved to another item), IQ will generate the HTML version of the document
 
To view the formatted output:
  • Switch to Browse mode (Menu > View > Browse Mode, or press Ctrl + M)
  • The generated HTML can be fine-tuned using a CSS Stylesheet file. See below for details
 

Editing Markdown documents

(this page was written entirely in Markdown and automatically formatted)
Paragraphs and character formatting:

Paragraphs are separated by a blank line.

Paragraphs which are not separated by a blank line are combined. So this second line will actually be shown with the previous one.

To add a carriage return, add 2 spaces at the end of the line.
So this text is now on a different line

Font attributes can be Italicbold, and monospace. To format, enclose the text with:

  • * for italic
  • ** for bold
  • ` for monospace
  • Underline and strikethrough are possible by enclosing the text with the HTML codes (<u> … </u> and <s> … </s>)
Lists:

To make a bullet list, add a blank line and start the list with either - or *:

  • this one
  • that one
  • the other one

or for numbered lists, start the line by 1. :

  1. first item
  2. second item
  3. third item
    To add a carriage return, add 2 spaces at the end of the line.
  4. One last item

(no need to enter the correct number for numbered list items, items will auto-increment)

To create nested lists, add 1 or more Tab character:

  • Level 1
    1. Level 2
    2. Level 2 again
  • Back to Level 1
  • One more
Tables:

Tables can look like this:

  Grouping
First Header Second Header Third Header
Content Long Cell
Content Cell Cell
New section More Data
And more And more
Hyperlinks:

Hyperlinks are entered using the following syntax: [Link text](Link URL)

Use Insert > Hyperlink (Ctrl + K) to show the Hyperlink dialog. All the standard IQ hyperlinks are allowed:

  • Web page URL
  • Local file
  • Item or list of items
  • Grid
  • All items in a field
  • etc.

Details here

Images:

Images handled like hyperlinks except that the link is preceded by !:

![Optional image text](Image URL):


Quotes:

Start the line with > for quotes:

Block quotes are written like so.

They can span multiple paragraphs, if you like.

Code:

Code can be formatted in 2 ways:

  • Tab (or 4 spaces) at the start of each line
  • Add ``` at the start and end of the block (easier to copy / paste code)

Tab:

Let me re-iterate ... for i in 1 .. 10 { do-something(i) } 

Delimited by ```:

define foobar() {      print "Welcome to flavor country!";   } 
Footnotes:

To create a footnote enter [^1]. The footnote text will be shown at the end of the document.

e.g. Here’s a footnote [1].

Definition lists:

Definitions are automatically formatted. To enter a definition enter the Word on a blank line. Then for each meaning, enter : followed by a Tab and the meaning:

Word

: Definition 1

: Definition 2

e.g.

Apple
Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
An american computer company.
Orange
The fruit of an evergreen tree of the genus Citrus.
Headers:

Headers are marked with one or more #. IQ will expand header levels so entering # 4 (no space) will be converted to #### which is a H4 header

A header (level 4)

Or by a line under, with 3 or more = for a main header and 3 or more - for lower level header:

An h1 header

An h2 header

Oher codes:
  • Use 3 dashes for an em-dash: —
  • Use 2 dashes for ranges (ex., “it’s all in chapters 12–14”).
  • Three dots will be converted to an ellipsis: …
  • Three underscores to draw a horizontal line
  • To prevent characters from being interpreted, precede it with \  e.g. \** will not bold text but this will be bold
Style Sheets and other header information

The Markdown document uses the MultiMarkdown syntax which is an extension over the standard Markdown. Amongst the enhancements, the format supports a header section.

  • CSS: Full path to the style sheet file
  • Title: Document title

The CSS file is particularly useful since it allows full control over the HTML generated from the Markdown



  1. Footnote text goes here.  ↩