You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can also use words, to fit your writing style more closely3.
Comments and escaping
Use \ to escape markdown: This text is *not bold* and _not italic_.
emojis and keyboard keys
👍 🏅 👎 💯 🏆 🏠
CtrlEnterSpaceCtrl+C
Tables
Left-aligned
Center-aligned
Right-aligned
title1
git status
1.75%
title2
git diff
2.81%
title3
git add
3.51%
Collapsable sections
Details
This content is hidden by default and you have to click `Details` to see it.
Details with custom summary
This content is hidden by default and you have to click `Details with custom summary` to see it.
Syntax highlighted code blocks
C#:
voidWriteHelloWorld(stringname){Console.WriteLine("Hello World and {0}!",name);}WriteHelloWorld("John Doe");// writes 'Hello World and Johnm Doe' to STDOUT
Ruby:
defprint_helloWorld(name)puts"Hello World and #{name}!"endprint_helloWorld('Jon Doe')#=> prints 'Hello World and Jon Doe!' to STDOUT.
JavaScript:
functionwriteHelloWorld(name){console.log(`Hello World and ${name}!`);}writeHelloWorld('Jon Doe');// writes 'Hello World and Jon Doe!' to STDOUT.
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!
Loading
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
Loading
Class diagram
classDiagram
Truck <|-- Vehicle : specialized
Bike *-- Vehicle
Truck : size()
Vehicle : int Wheels
Loading
Mentions
Mention using GitHub handle: @kaufm (only works in Issues and Pull Requests)
Every new line should be prefixed with 2 spaces.
This allows you to have a footnote with multiple lines. ↩
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. ↩
You can use markdown to write and format text in GitHub - in Issues, Pull Requests, and markdown files. Here is a list of the most important features.
Headings
#Heading##Heading2###Heading3Formatting text
Formatting
**bold text**,_italic text_and***bold and italic***.You can also use
~~strikethrough text~~.Links
https://xpirit.com/
Link Text
Test.pdf
Images
You can drag or drop images to markdown and they will get uploaded automatically.
Size images
Use
imgto set the with of the image:Display images depending on theme:
You can now also use
picturetag:Videos
DarkMode_dribbble.mp4
Lists
Nested lists
Footnotes
You can user a footnote1 in markdown that allows you to jump to it and back using links.
A footnote can have multiple lines2.
You can also use words, to fit your writing style more closely3.
Comments and escaping
Use \ to escape markdown: This text is *not bold* and _not italic_.
emojis and keyboard keys
👍
🏅 👎 💯 🏆 🏠
Ctrl Enter Space Ctrl+C
Tables
git statusgit diffgit addCollapsable sections
Details
This content is hidden by default and you have to click `Details` to see it.Details with custom summary
This content is hidden by default and you have to click `Details with custom summary` to see it.Syntax highlighted code blocks
C#:
Ruby:
JavaScript:
Flow Chart
graph RL; 7e536==>96a85; b7e6b==>7e536; main-.->b7e6b; HEAD-->main; 55805==>7e536; branch-.->55805; tag-.->55805;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!Gant Diagram
Class diagram
Mentions
Mention using GitHub handle: @kaufm (only works in Issues and Pull Requests)
Reference labels
Reference labels in markdown: https://github.com/wulfland/AccelerateDevOps/labels/documentation
Geo location
{ "type": "Feature", "geometry": { "type": "Point", "coordinates": [-4.842228, 36.502749] }, "properties": { "name": "Kitesurf Zone", "Conditions": "Poniente, Levante", "Ratings": "⭐ ⭐ ⭐ ⭐ ⭐ " } }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]] ] }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'Past tables and spreadsheets to markdown:
<style> </style>Disable using cmd|ctrl+shift+v:
Animal Color Amount
Tiger Yellow 25
Horse Brown 7
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:$\sqrt{3x-1}+(1+x)^2$
This sentence uses
$delimiters to show math inline:Footnotes
My reference. ↩
Every new line should be prefixed with 2 spaces.
This allows you to have a footnote with multiple lines. ↩
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. ↩