This issue contains the most important features of GitHub flavored markdown. See this page for the source and rendered version.

Note Not all features render in GitHub Pages !

Feb 15 '22 09:02 wulfland

Headings

`#` Heading

`##` Heading2

`###` Heading3

Formatting text

Formatting **bold text**, _italic text_ and ***bold and italic***. You can also use ~~~~strikethrough text~~~~.

> This is a quote

>> This is a nested quote

Feb 15 '22 09:02 wulfland

Links

https://xpirit.com/ Link Text

Feb 15 '22 09:02 wulfland

Images

octocat Test.pdf

Feb 15 '22 18:02 wulfland

Videos

https://user-images.githubusercontent.com/5276337/154125940-0172902e-da3f-4e6e-a4a4-cab7c6a86cde.mp4

Feb 16 '22 07:02 wulfland

Lists

List item 1
List item 2

Item 1
Item 2

Nested lists

Root
- First nested item
  - Second nested item

Feb 16 '22 07:02 wulfland

Footnotes

You can user a footnote[^1] in markdown that allows you to jump to it and back using links.

A footnote can have multiple lines[^2].

You can also use words, to fit your writing style more closely[^note].

[^1]: My reference. [^2]: Every new line should be prefixed with 2 spaces.
This allows you to have a footnote with multiple lines. [^note]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.
This footnote also has been made with a different syntax using 4 spaces for new lines.

Feb 16 '22 07:02 wulfland

Comments and escaping

Use \ to escape markdown: This text is *not bold* and _not italic_.

Feb 16 '22 08:02 wulfland

emojis and keyboard keys

:+1: :shipit: :medal_sports: :-1: :100: :trophy: :house:

Ctrl Enter Space Ctrl+C

Feb 16 '22 08:02 wulfland

Tables

Left-aligned	Center-aligned	Right-aligned
title1	`git status`	1.75%
title2	`git diff`	2.81%
title3	`git add`	3.51%

Feb 16 '22 15:02 wulfland

Collapsable sections

This content is hidden by default and you have to click `Details` to see it.

Details with custom summary

Feb 16 '22 15:02 wulfland

Syntax highlighted code blocks

C#:

void WriteHelloWorld(string name)
{
  Console.WriteLine("Hello World and {0}!", name);
}
WriteHelloWorld("John Doe");
// writes 'Hello World and Johnm Doe' to STDOUT

Ruby:

def print_helloWorld(name)
  puts "Hello World and #{name}!"
end
print_helloWorld('Jon Doe')
#=> prints 'Hello World and Jon Doe!' to STDOUT.

JavaScript:

function writeHelloWorld(name) {
  console.log(`Hello World and ${name}!`);
}
writeHelloWorld('Jon Doe');
// writes 'Hello World and Jon Doe!' to STDOUT.

Feb 16 '22 15:02 wulfland

Flow Chart

graph RL;
    7e536==>96a85;
    b7e6b==>7e536;
    main-.->b7e6b;
    HEAD-->main;
    55805==>7e536;
    branch-.->55805;
    tag-.->55805;

Feb 16 '22 15:02 wulfland

Sequence diagram

sequenceDiagram
    participant Me
    participant You
    Me->>You: Hello, how are you?
    loop Self reflection
        You->>You: How am I?
    end
    Note right of You: Say the truth? 🤔 
    You-->>Me: Great!

Feb 16 '22 15:02 wulfland

Gant Diagram

gantt
dateFormat  YYYY-MM-DD
title Preparing conference talk
excludes weekdays 2022-02-16

section Prep
Prepare Slides :done,    des1, 2022-02-01,2022-02-15
Prepare Demo :active,  des2, 2022-02-17, 3d

section Conference
Talk 1 : des3, after des2, 5d
Talk 2 : des4, after des3, 5d

Feb 16 '22 16:02 wulfland

Class diagram

classDiagram
Truck <|-- Vehicle : specialized
Bike *-- Vehicle
Truck : size()
Vehicle : int Wheels

Feb 16 '22 16:02 wulfland

Mentions

Mention using GitHub handle: @kaufm

Feb 16 '22 16:02 wulfland

Reference labels

Reference labels in markdown: https://github.com/wulfland/AccelerateDevOps/labels/documentation

Feb 23 '22 17:02 wulfland

Geo location

{
  "type": "Feature",
  "geometry": {
    "type": "Point",
    "coordinates": [-4.842228, 36.502749]
  },
  "properties": {
    "name": "Kitesurf Zone",
    "Conditions": "Poniente, Levante",
    "Ratings": "⭐ ⭐ ⭐ ⭐ ⭐ "
  }
}

Mar 23 '22 13:03 wulfland

topoJSON

{
    "type": "Topology",
    "objects": {
        "data": {
            "geometries": [
                {
                    "id": "0",
                    "type": "Polygon",
                    "properties": {"name": "abc"},
                    "bbox": [0.0, 0.0, 1.0, 1.0],
                    "arcs": [[-2, 0]]
                },
                {
                    "id": "1",
                    "type": "Polygon",
                    "properties": {"name": "def"},
                    "bbox": [1.0, 0.0, 2.0, 1.0],
                    "arcs": [[1, 2]]
                }
            ],
            "type": "GeometryCollection"
        }
    },
    "bbox": [0.0, 0.0, 2.0, 1.0],
    "arcs": [
        [[1.0, 0.0], [0.0, 0.0], [0.0, 1.0], [1.0, 1.0]], [[1.0, 0.0], [1.0, 1.0]],
        [[1.0, 1.0], [2.0, 1.0], [2.0, 0.0], [1.0, 0.0]]
    ]
}

Mar 23 '22 13:03 wulfland

STL 3D rendering

solid b'STLB ATF 10.13.0.1454 COLOR=&\x83\xe7\xff'
facet normal -0.000000 0.000000 34.810009
  outer loop
    vertex 50.000000 5.900000 5.900000
    vertex 50.000000 0.000000 5.900000
    vertex 55.900002 5.900000 5.900000
  endloop
endfacet
facet normal 0.000000 0.000000 34.810009
  outer loop
    vertex 55.900002 5.900000 5.900000
    vertex 50.000000 0.000000 5.900000
    vertex 55.900002 0.000000 5.900000
  endloop
endfacet
facet normal -0.000000 -0.000000 -34.810009
  outer loop
    vertex 55.900002 5.900000 0.000000
    vertex 55.900002 0.000000 0.000000
    vertex 50.000000 5.900000 0.000000
  endloop
endfacet
facet normal 0.000000 0.000000 -34.810009
  outer loop
    vertex 50.000000 5.900000 0.000000
    vertex 55.900002 0.000000 0.000000
    vertex 50.000000 0.000000 0.000000
  endloop
endfacet
facet normal 34.810001 -0.000000 0.000000
  outer loop
    vertex 55.900002 0.000000 5.900000
    vertex 55.900002 0.000000 0.000000
    vertex 55.900002 5.900000 5.900000
  endloop
endfacet
facet normal 34.810001 0.000000 0.000000
  outer loop
    vertex 55.900002 5.900000 5.900000
    vertex 55.900002 0.000000 0.000000
    vertex 55.900002 5.900000 0.000000
  endloop
endfacet
facet normal 0.000000 -34.810009 0.000000
  outer loop
    vertex 50.000000 0.000000 5.900000
    vertex 50.000000 0.000000 0.000000
    vertex 55.900002 0.000000 5.900000
  endloop
endfacet
facet normal 0.000000 -34.810009 -0.000000
  outer loop
    vertex 55.900002 0.000000 5.900000
    vertex 50.000000 0.000000 0.000000
    vertex 55.900002 0.000000 0.000000
  endloop
endfacet
facet normal -34.810001 -0.000000 -0.000000
  outer loop
    vertex 50.000000 5.900000 5.900000
    vertex 50.000000 5.900000 0.000000
    vertex 50.000000 0.000000 5.900000
  endloop
endfacet
facet normal -34.810001 0.000000 0.000000
  outer loop
    vertex 50.000000 0.000000 5.900000
    vertex 50.000000 5.900000 0.000000
    vertex 50.000000 0.000000 0.000000
  endloop
endfacet
facet normal 0.000000 34.810009 0.000000
  outer loop
    vertex 55.900002 5.900000 5.900000
    vertex 55.900002 5.900000 0.000000
    vertex 50.000000 5.900000 5.900000
  endloop
endfacet
facet normal 0.000000 34.810009 0.000000
  outer loop
    vertex 50.000000 5.900000 5.900000
    vertex 55.900002 5.900000 0.000000
    vertex 50.000000 5.900000 0.000000
  endloop
endfacet
endsolid b'STLB ATF 10.13.0.1454 COLOR=&\x83\xe7\xff'

Mar 23 '22 13:03 wulfland

Past tables and spreadsheets to markdown:

Animal	Color	Amount
Tiger	Yellow	25
Horse	Brown	7

Disable using cmd|ctrl+shift+v:

Animal Color Amount Tiger Yellow 25 Horse Brown 7

May 25 '22 14:05 wulfland

Render mathematical expressions in Markdown using LaTeX syntax:

The Cauchy-Schwarz Inequality $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

Render it inline: This sentence uses $ delimiters to show math inline: $\sqrt{3x-1}+(1+x)^2$

May 25 '22 14:05 wulfland

Display images depending on theme:

Light Dark

You can now also use picture tag - but you must refresh the page after switching the theme using the command palette:

May 25 '22 14:05 wulfland

Mermaid diagrams with themes

In themes the mermaid diagrams might look strange. @rajbos found out how to do this:

%%{init: {'theme':'dark'}}%%
pie title Some random data
  "Some percentage" : 15
  "Minority" : 5
  "Big part" : 80

Sep 09 '22 13:09 wulfland

Mardown helpers (public beta)

Type / and you will get a dropdown that will help you to write markdown:

Helpers currently include:

Codeblocks
Details
Saved Replies
Tables
Templates
Tasklists (new)

Mar 23 '23 09:03 wulfland

New delimiter syntax for inline mathematical expressions

LaTeX-style math syntax with dollar signs and backticks (for example $'\sqrt{3}'$ , $\sqrt{3}$)

$\sqrt{3x-1}+(1+x)^2$

May 17 '23 16:05 wulfland

AccelerateDevOps
AccelerateDevOps copied to clipboard

📝 About GitHub markdown

Headings

`#` Heading

`##` Heading2

`###` Heading3

Formatting text

Links

Images

Videos

Lists

Nested lists

Footnotes

Comments and escaping

emojis and keyboard keys

Tables

Collapsable sections

Syntax highlighted code blocks

Flow Chart

Sequence diagram

Gant Diagram

Class diagram

Mentions

Reference labels

Geo location

topoJSON

STL 3D rendering

Past tables and spreadsheets to markdown:

Render mathematical expressions in Markdown using LaTeX syntax:

Display images depending on theme:

Mermaid diagrams with themes

Mardown helpers (public beta)

New delimiter syntax for inline mathematical expressions

AccelerateDevOps AccelerateDevOps copied to clipboard

📝 About GitHub markdown

Headings

# Heading

## Heading2

### Heading3

Formatting text

Links

Images

Videos

Lists

Nested lists

Footnotes

Comments and escaping

emojis and keyboard keys

Tables

Collapsable sections

Syntax highlighted code blocks

Flow Chart

Sequence diagram

Gant Diagram

Class diagram

Mentions

Reference labels

Geo location

topoJSON

STL 3D rendering

Past tables and spreadsheets to markdown:

Render mathematical expressions in Markdown using LaTeX syntax:

Display images depending on theme:

Mermaid diagrams with themes

Mardown helpers (public beta)

New delimiter syntax for inline mathematical expressions

AccelerateDevOps
AccelerateDevOps copied to clipboard

`#` Heading

`##` Heading2

`###` Heading3