Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 About GitHub markdown #232

Open
wulfland opened this issue Feb 15, 2022 · 26 comments
Open

📝 About GitHub markdown #232

wulfland opened this issue Feb 15, 2022 · 26 comments
Assignees
Milestone

Comments

@wulfland
Copy link
Owner

wulfland commented Feb 15, 2022

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 !

@wulfland
Copy link
Owner Author

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

@wulfland
Copy link
Owner Author

wulfland commented Feb 15, 2022

Links

https://xpirit.com/
Link Text

@wulfland
Copy link
Owner Author

Images

octocat
Test.pdf

@wulfland
Copy link
Owner Author

Videos

DarkMode_dribbble.mp4

@wulfland
Copy link
Owner Author

Lists

  • List item 1
  • List item 2
  1. Item 1
  2. Item 2

Nested lists

  1. Root
    • First nested item
      • Second nested item

@wulfland
Copy link
Owner Author

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.

Footnotes

  1. My reference.

  2. Every new line should be prefixed with 2 spaces.
    This allows you to have a footnote with multiple lines.

  3. 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.

@wulfland
Copy link
Owner Author

Comments and escaping

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

@wulfland
Copy link
Owner Author

wulfland commented Feb 16, 2022

emojis and keyboard keys

👍 :shipit: 🏅 👎 💯 🏆 🏠

Ctrl Enter Space Ctrl+C

@wulfland
Copy link
Owner Author

Tables

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

@wulfland
Copy link
Owner Author

Collapsable sections

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

@wulfland
Copy link
Owner Author

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.

@wulfland
Copy link
Owner Author

Flow Chart

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

@wulfland
Copy link
Owner Author

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!
Loading

@wulfland
Copy link
Owner Author

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

@wulfland
Copy link
Owner Author

Class diagram

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

@wulfland wulfland reopened this Feb 16, 2022
@wulfland
Copy link
Owner Author

wulfland commented Feb 16, 2022

Mentions

Mention using GitHub handle: @kaufm

@wulfland wulfland added the documentation Improvements or additions to documentation label Feb 16, 2022
@wulfland wulfland self-assigned this Feb 16, 2022
@wulfland wulfland pinned this issue Feb 16, 2022
@wulfland
Copy link
Owner Author

Reference labels

Reference labels in markdown: documentation Improvements or additions to documentation

@wulfland wulfland added this to the Backlog milestone Feb 24, 2022
@wulfland wulfland changed the title About GitHub markdown 📝 About GitHub markdown Feb 24, 2022
@wulfland
Copy link
Owner Author

Geo location

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

@wulfland
Copy link
Owner Author

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]]
    ]
}
Loading

@wulfland
Copy link
Owner Author

wulfland commented Mar 23, 2022

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'

Loading

@wulfland
Copy link
Owner Author

wulfland commented May 25, 2022

Past tables and spreadsheets to markdown:

<style> </style>
Animal Color Amount
Tiger Yellow 25
Horse Brown 7

Disable using cmd|ctrl+shift+v:

Animal Color Amount
Tiger Yellow 25
Horse Brown 7

@wulfland
Copy link
Owner Author

wulfland commented May 25, 2022

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$

@wulfland
Copy link
Owner Author

wulfland commented May 25, 2022

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:

@wulfland
Copy link
Owner Author

Mardown helpers (public beta)

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

image

Helpers currently include:

  • Codeblocks
  • Details
  • Saved Replies
  • Tables
  • Templates
  • Tasklists (new)

@wulfland
Copy link
Owner Author

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$

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant