PocketBlocks Docs
English
English
  • Overview
  • Installation
  • Build apps
    • Create a new app
    • App editor
    • Event handlers
    • Write JavaScript
      • Write JavaScript in {{ }}
      • JavaScript query
      • Transformers
      • Temporary state
      • Data responder
      • Built-in JavaScript functions
      • Use third-party libraries
    • Component guides
      • Option lists
      • List View
      • Drawer
      • Image
      • Charts and graphs
      • File upload
      • Custom component
      • Use Markdown
    • Module
    • Design app UI
      • Style, theme, and usability
      • Design an efficient and user-friendly form
    • Navigation
    • Keyboard shortcuts
    • Version and release management
  • Build plugins
    • Develop UI component plugins
  • Workspace management
    • Authentication
    • Members and groups
    • Permissions for resources
    • Custom branding
  • Miscellaneous
    • Where are the Data Sources/Query Library?
    • Embedding Apps
Powered by GitBook
On this page
  • Markdown basics
  • GFM extension
  • HTML support
  • Appendix: Supported HTML tags
  1. Build apps
  2. Component guides

Use Markdown

PreviousCustom componentNextModule

Last updated 11 months ago

PocketBlocks supports you using the lightweight markup language Markdown to format texts in your app, such as changing the font size, inserting code, and adding a list. You can also embed HTML-formatted text in Markdown for more styling options.

Use Markdown in Text and Table components.

  • Text: Use Markdown for the input text.

  • Table: Use Markdown for column type.

Markdown basics

All Markdown syntax is valid in PocketBlocks.

  • Headings: Use hashtag (#) before heading. More hashtags, lower heading level.

  • Paragraphs: Use a blank line to separate texts into paragraphs.

  • Line breaks: Add at least two whitespaces at the end of a line and press Enter to start a new line.

  • Emphasis: Use single asterisk (∗) before and after text to convert it to italic text, double asterisks (∗∗) for bold text, and triple asterisks (∗∗∗) for italic bold text.

  • Blockquotes: Use the closing angle bracket (>) to create a blockquote.

  • Lists: Use hyphen (-), asterisk (∗), or plus sign (+) followed by a whitespace to create an unordered list, and use numbers followed by a period (.) to create an ordered list.

  • Code: Use backticks (`) before and after code to denote `code` in plain text, and three backticks (```) to present ```code block```.

  • Horizontal rules: Use at least three asterisks (∗∗∗), hyphens (---), or underscores (_ _ _) at the beginning of a line to create a horizontal rule.

  • Links: Use square brackets ([]) for the display text and parenthesis (()) for the link address. Note that no space should be inbetween. For example, [PocketBlocks](https://github.com/pedrozadotdev/pocketblocks).

  • Images: Use an exclamation mark (!) to start an image shiinsertion, and then use square bracket ([]) for the alternative text and parenthesis (()) for the link address or source path. The caption can follow the parentheses or start at a new line.

  • Escaping characters: Use backslash (\) to display the special symbols that Markdown uses. For instance, to print `` in plain text, you should use \`\` in Markdown.

GFM extension

You can also use GitHub Flavored Markdown (GFM) extensions for additional syntax.

HTML support

For security reasons, a few HTML tags including iframe and script are not permitted in PocketBlocks.

Appendix: Supported HTML tags

<h1>
<h2>
<h3>
<h4>
<h5>
<h6>
<br>
<b>
<i>
<strong>
<em>
<a>
<pre>
<code>
<img>
<tt>
<div>
<ins>
<del>
<sup>
<sub>
<p>
<ol>
<ul>
<table>
<thead>
<tbody>
<tfoot>
<blockquote>
<dl>
<dt>
<dd>
<kbd>
<q>
<samp>
<var>
<hr>
<ruby>
<rt>
<rp>
<li>
<tr>
<td>
<th>
<s>
<strike>
<summary>
<details>
<caption>
<figure>
<figcaption>
<abbr>
<bdo>
<cite>
<dfn>
<mark>
<small>
<span>
<time>
<wbr>
<input>

For more information, see .

Footnotes: Use caret (^) and number in square brackets ([]) to insert footnotes. For more information, see .

Strikethrough lines: Use double tilde (~~) before and after text to add strikethrough lines. For more information, see .

Tables: Use hyphens (-) separated by the vertical bar (|) to create the header row of a table, and continue using the vertical bar to separate content in cells. For more information, see .

Task lists: Use a whitespace in square brackets ([ ]) within the list format to create task lists. To mark a task completed, replace the whitespace with the letter x. For more information, see .

In PocketBlocks, you can use most HTML tags and properties. For more information, see .

Markdown guide
Footnotes
Styling text
Tables (extension)
Task lists
Embed HTML in Markdown