Markdown Style Test & Cheatsheet

by Danilo Ramos

Apr 5, 2023

GitHub Markdown test


Headings

A quote…

H3

H4

H5
H6 (The smallest heading)

Syntax coloring

#pragma once
#include "Header.h" // Contains ISomeClass and includes <vector>, <list>
#define PREPROCESSOR_DEFINITION

namespace MyNamespace
{
void GlobalFunction() {}
bool GlobalVariable = true;
/// <summary>
/// The quick brown fox jumps over the lazy dog
/// THE QUICK BROWN FOX JUMPS OVER THE LAZY DOG
/// </summary>
class SomeClass    : public ISomeClass
{
public:
    enum SomeEnum
    {
        ENUM_0 = 0,
        ENUM_1 = 1
    };
    struct SomeData
    {
        int m_Integer;
        float m_Float;
    };

    SomeClass() { m_Data = new SomeData(); }
    ~SomeClass() { delete m_Data; m_Data = 0; }

    static int DoSomethingStatic( int _Arg0, float _Arg1 )
    {
        std::vector<float> Vec = std::vector<float>();
        
        float f = 0.0f;
        for (int i = 0; i < _Arg0; ++i)
        {
            if (i % 3 != 0)
            {
                f += _Arg1;
                Vec.push_back(f);
            }
        }
        return Vec.size();
    }

    template<class _T>
    int DoSomethingNonStatic() const;
private:
    SomeData* m_Data;
    static SomeData* m_StaticData;
};

}    // MyNamespace

class Person:
  def __init__(mysillyobject, name, age):
    mysillyobject.name = name
    mysillyobject.age = age

  def myfunc(abc):
    print("Hello my name is " + abc.name)

p1 = Person("John", 36)
p1.myfunc()

Table(s)

Command Description Aligment left
git status List all new or modified files left
git diff Show file differences that haven’t been staged left

Collapsable

CLICK ME

We can hide anything, even code!

int main(int argc, char* argv[]) {
    return 0;
}

Image(s)

This is an image

Avatar


Lists

  1. A
  2. B
  3. C
  • A
  • B
  • C
  1. a
    1. b
    2. c

Emoji

with text


Footnotes

Here is a simple footnote1.

A footnote can also have multiple lines2.

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

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.


Spaechip plugin

MathJax || Image
Apple
Banana
Orange
Apple
Banana
Orange
Apple
Banana
Orange
Rowspan is 4
A. Peach
B. Orange
C. Banana
How’s it?
  1. example
  2. $I = \int \rho R^{2} dV$
It’s OK!

Math

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

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

Mermaid

Video


  1. My reference. 

  2. Every new line should be prefixed with 2 spaces.