Code Block Formatting Demo

This is what a regular code block that is inline will look like.

This here is a "plain" code block

@results: total 12
drwxr-xr-x  5 user staff 160 Jan 28 12:34 .
drwxr-xr-x 20 user staff 640 Jan 28 12:34 ..
-rw-r--r--  1 user staff   0 Jan 28 12:34 file.txt

A code block inside a bulleted list:

• this is the bullet text

  this is text
  this is text
  this is text
  this is text
  drwxr-xr-x 20 user staff 640 Jan 28 12:34 ..
  -rw-r--r--  1 user staff   0 Jan 28 12:34 file.txt

  note

  this is a note?

  and a multiline code comment
  and a multiline code comment

• this is another bullet

This here is a "example" block. an example with just results and no matching "language" ends up rendering like a plain code block

@results: total 12
drwxr-xr-x  5 user staff 160 Jan 28 12:34 .
drwxr-xr-x 20 user staff 640 Jan 28 12:34 ..
-rw-r--r--  1 user staff   0 Jan 28 12:34 file.txt

This here is a "example" block that has bash attached to it but does not have a command/code section

@results: total 12
drwxr-xr-x  5 user staff 160 Jan 28 12:34 .
drwxr-xr-x 20 user staff 640 Jan 28 12:34 ..
-rw-r--r--  1 user staff   0 Jan 28 12:34 file.txt

This is the paragraph leading up to the example. the example is down below this text. here is more text just to emulate what a long bit of text before the example might look like.

@description:
this is a longer description. it's long. it's trying to be really,
really long just to put some words between you and the upcoming
example. more than the code below it. I'm just typing a bunch of stuff
here so that it is a lot

@command:
ls -l

@code: This is an alternate title for the code block
print("Hello, World!")  # Python
print("Hello, World!")  # Python
print("Hello, World!")  # Python
results: the results go here
and this is fundd

console.log("Hello, World!"); // JavaScript

#include <stdio.h>
int main() { printf("Hello, World!\n"); return 0; } // C

echo "Hello, World!" # Bash

regular, text here

Regular paragraph here with a small code chuck in between.

note

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

tip

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

info

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

warning

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

danger

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

important

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

caution

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

GitHub Markdown Examples

A ReMark plugin translates imported GitHub admonitions to Docusaurus admonitions. Read more about importing GitHub Markdown.

[!NOTE]

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

[!TIP]

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

[!IMPORTANT]

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

[!WARNING]

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done

[!CAUTION]

Here is a line of regular text inline code blocks are here to see

this is the first line

    security_opt:
      - seccomp:unconfined

this is bash
while true; do echo "stuff"; echo "more stuff"; done

This is a summary and this is a code block

this is some text and an inline code block

here is more text code
and more code

this is bash
while true; do echo "stuff"; echo "more stuff"; done