Skip to content

markdown.md

Latest commit

 

History

History
249 lines (216 loc) · 6.11 KB

markdown.md

File metadata and controls

249 lines (216 loc) · 6.11 KB
title Markdown cheatsheet
tags md, syntax, github

Markdown cheatsheet

Misc

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse molestie pretium diam, eu varius nisi malesuada vitae. Phasellus quis turpis ut ipsum gravida varius.

// code also works inside
console.log("this is cool")

Lists also:

  • task A
    • subtask A.1
    • subtask A.2 done
  • task B

Tables too

ColA ColB
one two

Note
Even nested note-quotes

That's crazy man! Go get treated 💊

I know

Even headings

Or subheadings

Details also

coucou details

and permalinks

abernier/docs/test.md

Line 1 in 81876e4

coucou test md file

I'm small text

Here is a list:

  • A permalink to an deleted/old file (of this repo):

    abernier/docs/test.md

    Line 1 in 81876e4

    coucou test md file
  • a link to a closed issue: #1
  • some keyboard keys: wasd + space
  • An edited text: What the fuckhell!
ColA ColB
one two

hey I'm fine!

Hey how are you

Collapse

CLICK ME

We can hide anything, even code!3

   puts "Hello World"

Tasks

TODO:

  • task A
    • subtask A.1
    • subtask A.2 done
  • task B

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists

Math

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)$$

Math expressions - @see: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions

mermaid, stl, geojson

https://github.blog/changelog/label/markdown/#:~:text=Mermaid%2C%20topoJSON%2C%20geoJSON%2C%20and%20ASCII%20STL%20Diagrams%20Are%20Now%20Supported%20in%20Markdown%20and%20as%20Files

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
Loading

https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/

solid Mesh
  facet normal 1.000000 0.000000 0.000000
    outer loop
      vertex 10.000000 0.000000 0.000000
      vertex 10.000000 -20.000000 20.000000
      vertex 10.000000 -20.000000 0.000000
    endloop
  endfacet
  facet normal 1.000000 0.000000 0.000000
    outer loop
      vertex 10.000000 0.000000 20.000000
      vertex 10.000000 -20.000000 20.000000
      vertex 10.000000 0.000000 0.000000
    endloop
  endfacet
  facet normal -1.000000 0.000000 0.000000
    outer loop
      vertex -10.000000 -20.000000 0.000000
      vertex -10.000000 0.000000 20.000000
      vertex -10.000000 0.000000 0.000000
    endloop
  endfacet
  facet normal -1.000000 0.000000 0.000000
    outer loop
      vertex -10.000000 -20.000000 20.000000
      vertex -10.000000 0.000000 20.000000
      vertex -10.000000 -20.000000 0.000000
    endloop
  endfacet
  facet normal 0.000000 0.000000 1.000000
    outer loop
      vertex -10.000000 -20.000000 20.000000
      vertex 10.000000 0.000000 20.000000
      vertex -10.000000 0.000000 20.000000
    endloop
  endfacet
  facet normal 0.000000 -0.000000 1.000000
    outer loop
      vertex 10.000000 -20.000000 20.000000
      vertex 10.000000 0.000000 20.000000
      vertex -10.000000 -20.000000 20.000000
    endloop
  endfacet
  facet normal 0.000000 0.000000 -1.000000
    outer loop
      vertex -10.000000 0.000000 0.000000
      vertex 10.000000 -20.000000 0.000000
      vertex -10.000000 -20.000000 0.000000
    endloop
  endfacet
  facet normal -0.000000 -0.000000 -1.000000
    outer loop
      vertex 10.000000 0.000000 0.000000
      vertex 10.000000 -20.000000 0.000000
      vertex -10.000000 0.000000 0.000000
    endloop
  endfacet
  facet normal 0.000000 1.000000 0.000000
    outer loop
      vertex -10.000000 0.000000 0.000000
      vertex 10.000000 0.000000 20.000000
      vertex 10.000000 0.000000 0.000000
    endloop
  endfacet
  facet normal -0.000000 1.000000 0.000000
    outer loop
      vertex -10.000000 0.000000 20.000000
      vertex 10.000000 0.000000 20.000000
      vertex -10.000000 0.000000 0.000000
    endloop
  endfacet
  facet normal 0.000000 -1.000000 0.000000
    outer loop
      vertex 10.000000 -20.000000 0.000000
      vertex -10.000000 -20.000000 20.000000
      vertex -10.000000 -20.000000 0.000000
    endloop
  endfacet
  facet normal -0.000000 -1.000000 -0.000000
    outer loop
      vertex 10.000000 -20.000000 20.000000
      vertex -10.000000 -20.000000 20.000000
      vertex 10.000000 -20.000000 0.000000
    endloop
  endfacet
endsolid Mesh
Loading 
{
  "type": "Polygon",
  "coordinates": [
      [
          [-90,30],
          [-90,35],
          [-90,35],
          [-85,35],
          [-85,30]
      ]
  ]
}
Loading

Ressources

Footnotes

  1. I'm the foo foonote! ↩ ↩2

  2. I'm the bar footnote ↩

  3. My reference. ↩