lolow63 / markdown

Heading

Sub-heading

Alternative heading

Aternative sub-heading

Paragraphs are separated by a blank line.

Two spaces at the end of a line produce a line break.

Text attributes italic, bold, monospace.

Horizontal rule:

---

const sentence = 'A beautiful day in codeland';

const scream = (string) => {
	return string.toUpperCase();
}

console.log(scream(sentence));

Bullet lists nested within numbered list:

1. fruits
   • apple
   • banana
2. vegetables
   • carrot
   • broccoli

A link.

Markdown uses email-style characters for blockquoting.

Multiple paragraphs need to be prepended individually.

Most inline HTML tags are supported.

---

Using ```bash:

Folder structure:

Using cmd tree /F > tree.txt

C:.
¦   .gitignore
¦   compose.yaml
¦   README.md
¦   tree.txt
¦   
+---app
    ¦   .dockerignore
    ¦   .DS_Store
    ¦   Dockerfile
    ¦   package-lock.json
    ¦   package.json
    ¦   server.js
    ¦   
    +---config
    ¦       keys.js
    ¦       
    +---models
    ¦       Todo.js
    ¦       
    +---routes
    ¦       front.js
    ¦       
    +---views
            todos.ejs

Using cmd tree /F /A > tree.txt (ASCII format)

C:.
|   .gitignore
|   compose.yaml
|   README.md
|   tree.txt
|   treeA.txt
|   
\---app
    |   .dockerignore
    |   .DS_Store
    |   Dockerfile
    |   package-lock.json
    |   package.json
    |   server.js
    |   
    +---config
    |       keys.js
    |       
    +---models
    |       Todo.js
    |       
    +---routes
    |       front.js
    |       
    \---views
            todos.ejs

Using cmd tree /F

C:.
│   .gitignore
│   compose.yaml
│   README.md
│
└───app
    │   .dockerignore
    │   .DS_Store
    │   Dockerfile
    │   package-lock.json
    │   package.json
    │   server.js
    │
    ├───config
    │       keys.js
    │
    ├───models
    │       Todo.js
    │
    ├───routes
    │       front.js
    │
    └───views
            todos.ejs

---

Using Mermaid:

Diagrams

Flowchart:

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

Sequence diagram:

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!

Gantt diagram:

gantt
dateFormat  YYYY-MM-DD
title Adding GANTT diagram to mermaid
excludes weekdays 2014-01-10

section A section
Completed task            :done,    des1, 2014-01-06,2014-01-08
Active task               :active,  des2, 2014-01-09, 3d
Future task               :         des3, after des2, 5d
Future task2               :         des4, after des3, 5d

State diagram:

---
title: Simple sample
---
stateDiagram-v2
    [*] --> Still
    Still --> [*]

    Still --> Moving
    Moving --> Still
    Moving --> Crash
    Crash --> [*]

Class diagram:

classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label

Entity relationship diagram:

erDiagram
          CUSTOMER }|..|{ DELIVERY-ADDRESS : has
          CUSTOMER ||--o{ ORDER : places
          CUSTOMER ||--o{ INVOICE : "liable for"
          DELIVERY-ADDRESS ||--o{ ORDER : receives
          INVOICE ||--|{ ORDER : covers
          ORDER ||--|{ ORDER-ITEM : includes
          PRODUCT-CATEGORY ||--|{ PRODUCT : contains
          PRODUCT ||--o{ ORDER-ITEM : "ordered in"

User jouney diagram:

journey
    title My working day
    section Go to work
      Make tea: 5: Me
      Go upstairs: 3: Me
      Do work: 1: Me, Cat
    section Go home
      Go downstairs: 5: Me
      Sit down: 5: Me

Git graph:

    gitGraph
       commit
       commit
       branch develop
       commit
       commit
       commit
       checkout main
       commit
       commit

Pie chart:

pie title Pets adopted by volunteers
    "Dogs" : 386
    "Cats" : 85
    "Rats" : 15

Requirement diagram

    requirementDiagram

    requirement test_req {
    id: 1
    text: the test text.
    risk: high
    verifymethod: test
    }

    element test_entity {
    type: simulation
    }

    test_entity - satisfies -> test_req