Skip to content

edited on 17-10

Markdown content.

Multiple paragraphs.

More Markdown content.

  • list item a
  • list item b
C
1
2
3
4
5
6
#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}
C++
1
2
3
4
5
6
#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

Example

Markdown
1
2
3
* Sed sagittis eleifend rutrum
* Donec vitae suscipit est
* Nulla tempor lobortis orci
Markdown
1
2
3
1. Sed sagittis eleifend rutrum
2. Donec vitae suscipit est
3. Nulla tempor lobortis orci

😄 ❤ 👍

Collapsible blocks with only ???

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Adding a + after the ??? token renders the block expanded:

Note

I am testing things temporarily here

Note

I am testing things temporarily here

Add keyboard keys example Ctrl+Alt+Del

show symbols: ™ © ®

Snippets example:

about.md
1
2
3
# About

This is Husain.

Method Description
GET Fetch resource
PUT Update resource
DELETE Delete resource

Fruit Count

bold and italic This * won't emphasize * This will emphasize

I'm italic and bold I am just bold.

I'm bold and italic! I am just italic.

I'm italic. I'm bold and italic. I'm also just italic.

A lot of underscores____________is okay

This will all be bold __because of the placement of the center underscores.

This will all be bold __ because of the placement of the center underscores.

This will NOT all be bold because of the placement of the center underscores.__

This will all be bold_ because of the token is less than that of the surrounding.

All will * be italic

All will *be italic

All will not be italic*

All will not ** be italic

All will * be bold

All will *be bold

All will not* be bold**

All will not *** be bold

  • This was marked (highlight)
  • This was inserted (underline)
  • This was deleted (strikethrough)
  • H2O
  • ATA

Python
1
2
3
4
5
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
Python
3
4
5
6
7
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
this is the title
1
2
3
4
5
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Highlighting specific lines:

Python
1
2
3
4
5
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Highlighting inline code blocks:

The range() function is used to generate a sequence of numbers.

Mermaid Diagrams (cant render when viewing locally in docker)⚓︎

graph LR
  A[Start] --> B{Error?};
  B -->|Yes| C[Hmm...];
  C --> D[Debug];
  D --> B;
  B ---->|No| E[Yay!];
sequenceDiagram
  autonumber
  Alice->>John: Hello John, how are you?
  loop Healthcheck
      John->>John: Fight against hypochondria
  end
  Note right of John: Rational thoughts!
  John-->>Alice: Great!
  John->>Bob: How about you?
  Bob-->>John: Jolly good!
stateDiagram-v2
  state fork_state <<fork>>
    [*] --> fork_state
    fork_state --> State2
    fork_state --> State3

    state join_state <<join>>
    State2 --> join_state
    State3 --> join_state
    join_state --> State4
    State4 --> [*]
classDiagram
  Person <|-- Student
  Person <|-- Professor
  Person : +String name
  Person : +String phoneNumber
  Person : +String emailAddress
  Person: +purchaseParkingPass()
  Address "1" <-- "0..1" Person:lives at
  class Student{
    +int studentNumber
    +int averageMark
    +isEligibleToEnrol()
    +getSeminarsTaken()
  }
  class Professor{
    +int salary
  }
  class Address{
    +String street
    +String city
    +String state
    +int postalCode
    +String country
    -validate()
    +outputAsLabel()
  }

erDiagram
  CUSTOMER ||--o{ ORDER : places
  ORDER ||--|{ LINE-ITEM : contains
  LINE-ITEM {
    string name
    int pricePerUnit
  }
  CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
Tasklists

  • Lorem ipsum dolor sit amet, consectetur adipiscing elit
  • Vestibulum convallis sit amet nisi a tincidunt
    • In hac habitasse platea dictumst
    • In scelerisque nibh non dolor mollis congue sed et metus
    • Praesent sed risus massa
  • Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

Below stuff not working yet⚓︎

Adding annotations:

YAML
1
2
3
theme:
  features:
    - content.code.annotate # (1)

  1. 🙋‍♂️ I'm a code annotation! I can contain code, formatted text, images, ... basically anything that can be written in Markdown.
Embedding external files⚓︎

When [Snippets] is enabled, content from other files (including source files) can be embedded by using the --8<-- notation directly from within a code block:

Code block with external content
1
2
3
``` title=".browserslistrc"
--8<-- ".browserslistrc"
```
.browserslistrc
1
last 4 years
About Author⚓︎

Systems & Network Administrator (CCNA) whose been in IT since 2008. Has strong working knowledge of Linux for servers and networking & is passionate about everything computer and technology.