Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 1.33 KB

quickguide-markdown.md

File metadata and controls

68 lines (40 loc) · 1.33 KB
Raw

Common Markdown syntax

Below is common Syntax that you can easily use in any markdown editor, including a text editor

https://www.markdownguide.org/basic-syntax/

https://www.markdownguide.org/tools/typora/

Headings

Typora: Paragraph > Heading 1 cmd+1

Heading 1 through 6 are allowed

Bulleted list

Typora: Paragraph > Unordered List

  • List Item 1
  • List Item 2
  • List Item 3

Numbered list

Typora: Paragraph > Ordered List

  1. Step 1
  2. Step 2
  3. Step 3

Notes

Typora:Paragraph > Quote

Note: Lorem Ipsum

Caution: Lorem Ipsum

Warning: Lorem Ipsum

Tip: Lorem Ipsum

Tables

Typora: Paragraph > Table

Field Type Value
jcr:content String Title Component
sling:resourcetype String training/components/title
componentGroup String We.Train

Variables, paths, and other code highlighting in text

Typora: Format > Code

/apps/wknd/components/helloworld/helloworld.html

Code Blocks

Typora: Paragraph > Code Fences

//Code Fences
String foobar = "Hello World";

When you create a code block like above, make sure to specify the language (java, html, css) for code highlighting.