Skip to main content
SmartDoc: Using Markdown

Shortcuts to formatting and embed functions to streamline your SmartDoc editing

Peter Novosel avatar
Written by Peter Novosel
Updated over a week ago

SmartDoc fields have a long list of powerful capabilities - you can format content, embed a wide variety of elements from tables to images to video content. Markdown brings those capabilities to you as shortcuts, available during SmartDoc editing through specific key combinations or inline character input.

Why use markdown?

Casual users of SmartDocs will appreciate the easy-to-understand user interfaces, with popup tooltips describing functions and clear descriptions of embed-able components from the slash command menu. Power users - people working with formatted content on a regular basis - often use some of these features repeatedly and need a quick and efficient way to access those functions. That's where markdown comes in.

These time-saving techniques put many of the often-accessed formatting capabilities at your fingertips. Use Control-B to bold test, type a # (hash) character to reference another record - the list goes on. Reducing your "hand on mouse" time increases the time you can spend generating your content - no fuss, no pauses - just productivity.


Markdown Syntax

Inline at the beginning of a line:

  • > space creates a block quote

  • ``` creates a code block

  • - space or * space starts an unordered list

  • 1. space starts a numbered list (Also, if you use 2 or any other number, the list will start at that number)

  • # space creates a H1 heading

  • ## space creates a H2 heading

  • ### space creates a H3 heading

  • #### space creates a H4 heading

  • ##### space creates a H5 heading

  • ###### space creates a H6 heading

Inline anywhere in the text:

  • text between ` characters (the "backtick," which shares the key on your keyboard with tilde ~) is converted to code formatting

  • text between ** characters will be formatted in bold

  • text between * characters will be formatted in italics

  • text between ~~ (tilde) characters will be formatted with strikethrough

@ and # Commands:

  • Mention a Member: Type @ and a Member's name - you will be able to see a filtered list of matching Members. Click the one you want to mention (or hit the enter key) and they'll be linked to the SmartDoc. They'll also receive a notification that they were mentioned!

  • Link a Record: Type # and the name (Primary Field) of a record - you'll be shown a list of records from the Solution that match. Click one (or hit enter) to link it to the SmartDoc.

Keyboard Shortcuts:

The following keyboard shortcuts either apply formatting to selected text, or toggle the formatting mode on or off.

Note: The abbreviation ctrl (control) should be replaced with cmd (command) on Mac computers.

  • ctrl+b activates bold

  • ctrl+i activates italic

  • ctrl+s activates strikethrough

  • shift+control+[1, 2, 3, 4 or 5] switch the current selection to heading level 1, 2, 3, 4 or 5

  • shift+control+0 switches the current selection to regular paragraph formatting

  • ctrl+a selects all content in the SmartDoc

  • shift+enter creates a line break (without creating a new paragraph)

  • ctrl+_ creates a horizontal line

  • ctrl+z undo

  • shift+ctrl+z redo

Emoji

Certain character combinations are converted to emoji automatically as you type (after you enter the key combination and hit space). These are a few examples:

  • :-) converts to πŸ˜ƒ

  • ;-) converts to πŸ˜‰

  • <3 converts to ❀️

You can find emojis by typing a : (colon) followed by a descriptive word. A few ideas to get you started:

  • :heart

  • :party

  • :person

  • :cat

You can read all about Emoji (including more auto-converted text) in this article.

Web Links

If you type or paste a URL (hyperlink) into a SmartDoc, it will automatically converted to a clickable link:

www.smartsuite.com becomes www.smartsuite.com

Did this answer your question?