Skip to content

Style Guide

This guide demonstrates the standard typography, formatting, components, and code styles used throughout the Tux documentation. Use this reference to ensure consistency when writing new content.

Headings

The following headings demonstrate the typographic scale.

H1: Main Page Title

H2: Section Title

H3: Subsection Title

H4: Minor Heading

H5: Small Heading
H6: Tiny Heading

Paragraph Text

Standard Paragraph (16px) How vexingly quick daft zebras jump. This is standard paragraph text that should render at exactly 16px. The quick brown fox jumps over the lazy dog. Typography is the art and technique of arranging type to make written language legible, readable and appealing when displayed.

Small Text This is small text (13.33px). Useful for captions, footnotes, and secondary information.

Extra Small Text This is extra small text (11.11px). Use this for very fine print or disclaimers.

Inline Styles

  • Bold: **Bold** or __Bold__
  • Italic: *Italic* or _Italic_
  • Bold Italic: ***Bold Italic***
  • Strikethrough: ~~Strikethrough~~
  • Inline Code: `Inline Code`
  • Link: [Link](https://example.com)
  • Superscript: ^^Superscript^^
  • Subscript: ~~Subscript~~ (using tilde syntax if enabled, otherwise HTML )
  • Highlight: ==Highlight==

Blockquotes

This is a blockquote. It is used for highlighting key takeaways or citations.

It can span multiple paragraphs.

Admonitions

Admonitions are used to call attention to important information.

Note

Note: Useful for general information or context.

Tip

Tip: Helpful advice or shortcuts.

Success

Success: Indicates a successful action or positive outcome.

Warning

Warning: Alerts the user to potential issues or important caveats.

Failure

Failure: Indicates a failed action or negative outcome.

Danger

Danger: Critical warning where data loss or severe issues could occur.

Bug

Bug: Highlights a known issue or bug.

Example

Example: Provides a practical example of a concept.

Quote

Quote: Citations or quoted text.

Collapsible Details

Click to expand

This is a collapsible details block. It's useful for hiding optional or advanced details.

You can put any content inside, including code blocks.

Content Tabs

Python
print("Hello from Python tab")
JavaScript
console.log("Hello from JS tab");

Task Lists

  • Completed task
  • Pending task
  • Another pending task

Code Blocks

Python

example.py
def hello_world():
    """A simple function."""
    print("Hello, World!")
    return True

Bash

Terminal
# Install dependencies
uv sync

# Run the bot
uv run tux start

JSON

config.json
{
  "name": "Tux",
  "version": "1.0.0",
  "active": true
}

Code Annotations

Python
def connect_db():
    db = Database() # (1)
    db.connect()    # (2)
    return db
  1. Initialize the database connection object.
  2. Establish the actual connection to the server.

Color Palette Demo

Coming soon: Interactive color palette demonstration

Lists

Unordered

  • Item One
  • Item Two
    • Nested Item A
    • Nested Item B
  • Item Three

Ordered

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

Tables

Feature Status Notes
Auth ✅ Ready OAuth2 implemented
API 🚧 WIP Rate limiting pending
UI ❌ todo Needs design

Horizontal Rule


(The line above is a horizontal rule)

Type Scale Diagnostic

This interactive tool measures the actual computed font sizes of elements on this page to verify they match our design system specifications.

Font Size Measurements

Element Target Size Actual Size
H1 Heading 47.78px ---
H2 Heading 39.81px ---
H3 Heading 33.18px ---
H4 Heading 27.65px ---
Paragraph 16.00px ---
Small Text 13.33px ---

Environment Information

Property Value
Viewport calculating...
Root Font Size calculating...
Base REM Unit calculating...