FAXES Documentation > Product Documenation > FAXES Markdown Guide

FAXES Markdown Guide

FAXES

This guide covers all the Markdown options possible in the below listed FAXES products. Some features may not be reflected in some products which will be outlined.

This is intented as a quick reference guide for possible Markdown formatting types through the markdown-it-faxes package with the node package manager.

Each item contains the Markdown code and then the shown example.


Table of Contents


Headers

Code:

# H1
## H2
### H3
#### H4

Example:

H1

H2

H3

H4


Emphasis

Code:

*This is italics. Using one asterisk on both sides of the text area.*

**This is bold text. Using two asterisks on both sides of the text**

~~You can also strikethrough text with two tildes on either side of the text.

Even better you can combine these **bold text with *italic text*.** 

Example:
This is italics. Using one asterisk on both sides of the text area.

This is bold text. Using two asterisks on both sides of the text

~~You can also strikethrough text with two tildes on either side of the text.

Even better you can combine these bold text with italic text.


Lists

Code:

- sub list that's;
- unordered

1. numerical list;
2. that's ordered

Example:

  • sub list that's;

  • unordered

  1. numerical list;

  2. that's ordered


Code:

https://faxes.zone will appear as a text link.

[faxes.zone](https://faxes.zone) will appear as a hyperlink.

Example:
https://faxes.zone will appear as a text link.

faxes.zone will appear as a hyperlink.


Images

Code:

![alt text](https://faxes.zone/i/3T5oZ.gif)

Example:
alt text


Code and Syntax Highlighting

In the code example below a space is added into the ` symbols to avoid it being formatted

Code:

Inline `code` has `back-ticks around` it.

`` `javascript
var s = "JavaScript syntax highlighting";
alert(s);
`` `

`` `
No language indicated, so no syntax highlighting.
`` `

Example:
Inline code has back-ticks around it.

var s = "JavaScript syntax highlighting";
alert(s);
No language indicated, so no syntax highlighting.

Tables

Use www.tablesgenerator.com/markdown_tables for an easy conversion.

Code:

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3      | content | $1600 |
| col 2      | more content here      |   $12 |
| zebra stripes | are neat      |    $1 |

Example:

Tables Are Cool
col 3 content $1600
col 2 more content here $12
zebra stripes are neat $1

Horizontal Rule

Code:

---

Example:


[End example]


Line Breaks

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a *separate paragraph*.

This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the same paragraph.


Credits to adam-p on GitHub for providing a public guide.