Github Markup Cheat Sheet



  1. Github Markup Cheat Sheet Excel
  2. Github Markup Cheat Sheet
  3. Github Markdown Cheat Sheet Emoji
  4. Markdown Cheatsheet Code
  5. Github Markup Cheat Sheet 2019

ReadText(type) writeText(text, type) readHTML(type) writeHTML(markup, type) readImage(type) writeImage(image, type) readRTF(type) writeRTF(text, type). Markdown cheat sheet. GitHub Gist: instantly share code, notes, and snippets.

  • Applications

  • Support

  • Joplin API - Get Started

  • Joplin API - References

  • Development

  • Google Summer of Code 2021

  • About

Markdown is a simple way to format text that looks great on any device. It doesn't do anything fancy like change the font size, color, or type — just the essentials, using keyboard symbols you already know. Since it is plain text, it is an easy way to author notes and documents and when needed it can be converted to a rich text HTML document.

Joplin desktop and mobile applications can display both the Markdown text and the rendered rich text document.

Github Markup Cheat Sheet Excel

Joplin follows the CommonMark specification, with additional features added via plugins.

Cheat Sheet🔗

This is a quick summary of the Markdown syntax.

MarkdownRendered Output
Heading 1
Heading 2

Heading 2

Heading 3

Heading 3

BoldThis is some bold text
ItalicThis is some italic text
Blockquotes
Kent.
Where's the king?
Gent.
Contending with
the fretful elements
List
  • Milk
  • Eggs
  • Beers
    • Desperados
    • Heineken
  • Ham
Ordered list
  1. Introduction
  2. Main topic
    1. First sub-topic
    2. Second sub-topic
  3. Conclusion
Inline codeThis is someJavaScript()
Code blockHere's some JavaScript code:
Language is normally auto-detected, but it can also be specified:
Unformatted textIndent with a tab or 4 spaces for unformatted text.
LinkThis is detected as a link:
https://joplinapp.org
And this is a link anchoring text content:
Joplin
And this is a link, with a title,
anchoring text content:
Joplin (hint: hover over the link)
Images
Horizontal RuleOne rule:
Another rule:
TablesSee below

Tables🔗

Tables are created using pipes | and and hyphens -. This is a Markdown table:

Which is rendered as:

First HeaderSecond Header
Content CellContent Cell
Content CellContent Cell

Github Markup Cheat Sheet

Note that there must be at least 3 dashes separating each header cell.

Github

Colons can be used to align columns:

Which is rendered as:

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12

Joplin Extras🔗

Besides the standard Markdown syntax, Joplin supports several additional features.

Links to other notes🔗

You can create a link to a note by specifying its ID in the URL. For example:

Since getting the ID of a note is not straightforward, each app provides a way to create such link. In the desktop app, right click on a note an select 'Copy Markdown link'. In the mobile app, open a note and, in the top right menu, select 'Copy Markdown link'. You can then paste this link anywhere in another note.

Math notation🔗

Markdown

Math expressions can be added using the KaTeX notation. To add an inline equation, wrap the expression in $EXPRESSION$, eg. $sqrt{3x-1}+(1+x)^2$. To create an expression block, wrap it as follow:

For example:

Here is an example with the Markdown and rendered result side by side:

Chemical equations🔗

Joplin supports chemical equations via the mhchem plugin for KaTeX. This plugin is automatically enabled if you enable math notation. See the mhchem documentation for the syntax.

Diagrams🔗

Github Markup Cheat Sheet

You can create diagrams in Joplin using the Mermaid syntax. To add such a graph, wrap the Mermaid script inside a '```mermaid' code block like this:

This is how it would look with the Markdown on the left, and rendered graph on the right:

Markup

Note that Mermaid graphs are always rendered on a white background regardless of the current theme. This is because they can contain various colours that may not be compatible with the current theme.

Readme

Checkboxes🔗

Checkboxes can be added like so:

Github Markdown Cheat Sheet Emoji

Which would turn into:

The checkboxes can then be ticked in the mobile and desktop applications.

HTML support🔗

Markdown Cheatsheet Code

It is generally recommended to enter the notes as Markdown as it makes the notes easier to edit. However for cases where certain features aren't supported (such as strikethrough or to highlight text), you can also use HTML code directly. For example this would be a valid note:

Plugins🔗

Joplin supports a number of plugins that can be toggled on/off to enable/disable markdown features on top of the standard Markdown features you would expect. These plugins are listed below. Note: not all of the plugins are enabled by default, if the enable field is 'no' below, then open the option screen to enable the plugin. Plugins can be disabled in the same manner.

Note that the functionality added by these plugins is not part of the CommonMark spec so, while they will all work within Joplin, it is not guaranteed that they will work in other Markdown readers. Often this is not an issue but keep it in mind if you require compatibility with other Markdown applications.

Github Markup Cheat Sheet 2019

PluginSyntaxDescriptionEnabledScreenshot
Soft breaksSee breaks markdown-it demoJoplin uses hard breaks by default, which means that a line break is rendered as <br>. Enable soft breaks for traditional markdown line-break behaviour.noView
TypographerSee typographer markdown-it demoDoes typographic replacements, (c) -> © and so onnoView
LinkifySee linkify markdown-it demoAuto-detects URLs and convert them to clickable linksyes
Katex$$math expr$$ or $math$See aboveyesView
Fountain```fountain
Your screenplay...
```
Adds support for the Fountain markup language, a plain text markup language for screenwritingnoView
Mermaid```mermaid
mermaid syntax...
```
See plugin page for full descriptionyesView
MarkmarkedTransforms into <mark>marked</mark> (highlighted)yesView
FootnoteSimples inline footnote ^[I'm inline!]See plugin page for full descriptionyesView
TOCAny of ${toc}, [[toc]], [toc], [[_toc_]]Adds a table of contents to the location of the toc page. Based on headings and sub-headingsyesView
SubX~1~Transforms into X1noView
SupX^2^Transforms into X2noView
DeflistSee pandoc page for syntaxAdds the html <dl> tag accessible through markdownnoView
Abbr*[HTML]: Hyper Text Markup Language
The HTML specification
Allows definition of abbreviations that can be hovered over later for a full expansionnoView
Emoji:smile:Transforms into 😄. See this list for more emojisnoView
Insert++inserted++Transforms into <ins>inserted</ins> ()noView
MultitableSee MultiMarkdown pageAdds more power and customization to markdown tablesnoView