bbs-md/vault/markdown-showcase.md

description

description
See all supported markdown constructs in action

Markdown Showcase

This page demonstrates every markdown construct that BBS-MD renders. Use it as a reference or a test page.

Headers

Headers from H1 through H6 each have distinct styling. H1 and H2 get decorative underlines.

This is H3

This is H4

This is H5

This is H6

Text Formatting

Here's bold text, italic text, and bold italic combined. You can also use strikethrough for deleted content. Mix them freely: all at once.

Inline code spans render in a distinct color for quick identification.

Lists

Unordered

• First level item
  • Second level with different bullet
    • Third level goes deeper
  • Back to second level
• Another top-level item

Ordered

1. First step
2. Second step
3. Third step
   1. Sub-step A
   2. Sub-step B
4. Fourth step

Code Blocks

Rust

use std::collections::HashMap;

struct BBS {
    name: String,
    pages: HashMap<String, Page>,
}

impl BBS {
    fn new(name: &str) -> Self {
        BBS {
            name: name.to_string(),
            pages: HashMap::new(),
        }
    }

    fn add_page(&mut self, slug: &str, page: Page) {
        self.pages.insert(slug.to_string(), page);
    }
}

Python

class VaultReader:
    def __init__(self, path: str):
        self.path = path
        self.pages = {}

    def load_all(self):
        for md_file in Path(self.path).glob("**/*.md"):
            slug = md_file.stem
            self.pages[slug] = md_file.read_text()
        return self

Shell

#!/bin/bash
# Deploy BBS-MD as a login shell
useradd -m -s /usr/local/bin/bbs-md bbsuser
mkdir -p /home/bbsuser/vault
cp -r ./demo-vault/* /home/bbsuser/vault/
echo "BBS user created. Connect via: ssh bbsuser@localhost"

Plain (no language)

No syntax highlighting here.
Just plain monospaced text in a box.
Useful for ASCII diagrams or raw output.

Blockquotes

This is a simple blockquote. It gets a yellow pipe border on the left and gray text.

Multiple levels of nesting work too:

Nested blockquote. The borders stack.

Three levels deep. Still readable.

Tables

Basic Table

Planet	Moons	Ring System
Mercury	0	No
Venus	0	No
Earth	1	No
Mars	2	No
Jupiter	95	Yes
Saturn	146	Yes

Aligned Columns

Left	Center	Right
Alpha	Beta	Gamma
One	Two	Three
Short	Medium	Longtext

Horizontal Rule

Content above the rule.

---

Content below the rule.

Links

Wiki-Links

• Features — internal wiki-link to another vault page
• Directory — magic link to the directory listing
• Nonexistent Page — broken link shown in red strikethrough

Standard Links

• Features Page — standard markdown link
• Navigation — another standard link

Images

Images render as text placeholders since we're in a terminal:

---

Back to index.