Difference between revisions of "Markdown Editor"

From WHMCS Documentation

Line 1: Line 1:
WHMCS has implemented Bootstrap Markdown Editor to the ticket system as a Markdown Editor. The editor allows users who may not know Markdown to use toolbar buttons and shortcuts. Also, the syntax renders while editing to show the expected result. Headings are larger, emphasised words italicise, links underline, etc.
+
WHMCS supports Markdown for ticket formatting.
  
=== Autosaving ===
+
An editor is provided that makes it easy to apply common formatting. Supported formatting includes:
The editor has a built in auto-save feature. In WHMCS, this means that each ticket reply or note will save every 10 seconds. Auto-save uses Browser storage, so each user has unique saved replies.  
+
 
The save will load when visiting a ticket visited before. Each auto-save has a unique filename. This means that a user can start a reply on many tickets and have them saved separately. Notes also have this same functionality.
+
* '''Bold'''
The saved file clears when submitting a reply or note.
+
* ''Italics''
 +
* Headings
 +
* Bulleted Lists
 +
* Numbered Lists
 +
* Code Blocks
 +
* Quotes
  
 
=== Markdown Guide ===
 
=== Markdown Guide ===
  
This is the same guide displayed in WHMCS when clicking the Markdown Guide toolbar button.
+
A convenient and easily accessible Markdown Guide is provided within the product accessible via the Help icon within the editor toolbar at any time.
 
 
'''Emphasis'''
 
 
 
'''<nowiki>**bold**</nowiki>'''
 
 
 
''<nowiki>*italics*</nowiki>''
 
 
 
<nowiki>~~strikethrough~~</nowiki>
 
 
 
'''Headers'''
 
 
 
<nowiki># Big header
 
 
 
## Medium header
 
 
 
### Small header
 
 
 
#### Tiny header</nowiki>
 
 
 
'''Lists'''
 
 
 
<nowiki>* Generic list item
 
 
 
* Generic list item
 
 
 
* Generic list item
 
 
 
1. Numbered list item
 
 
 
2. Numbered list item
 
 
 
3. Numbered list item</nowiki>
 
 
 
'''Links'''
 
 
 
[Text to display](http://www.example.com)
 
 
 
'''Quotes'''
 
 
 
<nowiki>> This is a quote.
 
 
 
> It can span multiple lines!</nowiki>
 
 
 
'''Tables'''
 
 
 
<nowiki>| Column 1 | Column 2 | Column 3 |
 
 
 
| -------- | -------- | -------- |
 
 
 
| John | Doe | Male |
 
 
 
| Mary | Smith | Female |</nowiki>
 
 
 
Or without aligning the columns...
 
 
 
<nowiki>| Column 1 | Column 2 | Column 3 |
 
 
 
| -------- | -------- | -------- |
 
 
 
| John | Doe | Male |
 
 
 
| Mary | Smith | Female |</nowiki>
 
 
 
'''Displaying code'''
 
 
 
<nowiki>`var example = "hello!";`
 
 
 
Or spanning multiple lines...
 
 
 
```
 
 
 
var example = "hello!";
 
 
 
alert(example);
 
  
```</nowiki>
+
A similar online guide is available at https://marketplace.whmcs.com/help/markdown

Revision as of 18:31, 29 March 2016

WHMCS supports Markdown for ticket formatting.

An editor is provided that makes it easy to apply common formatting. Supported formatting includes:

  • Bold
  • Italics
  • Headings
  • Bulleted Lists
  • Numbered Lists
  • Code Blocks
  • Quotes

Markdown Guide

A convenient and easily accessible Markdown Guide is provided within the product accessible via the Help icon within the editor toolbar at any time.

A similar online guide is available at https://marketplace.whmcs.com/help/markdown