Markdown cheat sheet

Quick reference for SPLASH-specific formatting.

This page provides quick examples of SPLASH-specific formatting. For comprehensive documentation:

Basic Markdown: GitHub’s Markdown guide
Page metadata and attributes: ELIXIR Toolkit Theme - Page mechanics
Complete formatting guide: ELIXIR Toolkit Theme - Markdown cheat sheet

We use Kramdown for advanced Markdown features.

Message boxes

Use callouts to highlight important information:

Note: This is a note.

Tip: This is a tip.

Warning: This is a warning.

Important: This is important information.

Code:

{% include callout.html type="note" content="Your message here." %}

Replace note with tip, warning, or important as needed.

Images

Figure 1. Image with caption.

Code:

{% include image.html file="/infrastructures/ELIXIR-logo.svg" caption="Figure 1. Image with caption." alt="ELIXIR logo" %}

Attributes:

file: Path to image in /assets/img/ directory (required)
alt: Description for accessibility (required)
caption: Text displayed below image
max-width: Maximum width (e.g., "10em" or "300px")
click: Set to true to make image clickable
url: Custom link destination
inline: Set to true for use in lists

Smaller image example:

Code:

{% include image.html file="infrastructures/ELIXIR-logo.svg" alt="ELIXIR logo" max-width="3em" %}

Tables

| Priority apples | Second priority | Third priority |
|-------|--------|---------|
| ambrosia | gala | red delicious |
| pink lady | jazz | macintosh |
| honeycrisp | granny smith | fuji |

Result:

Priority apples	Second priority	Third priority
ambrosia	gala	red delicious
pink lady	jazz	macintosh
honeycrisp	granny smith	fuji

Icons

We use Font Awesome icons. Example:

<i class="fa-solid fa-camera-retro"></i> normal
<i class="fa-solid fa-camera-retro fa-2x"></i> 2x size
<i class="fa-solid fa-camera-retro fa-3x"></i> 3x size

Result: normal 2x 3x

Code snippets

Use fenced code blocks with language specification for syntax highlighting:

```python
def hello_world():
    print("Hello, world!")
```

Result:

def hello_world():
    print("Hello, world!")

Links

External links:

[GitHub Documentation](https://docs.github.com)

Internal pages:

[Style guide](style_guide)

Important: If you change file names, internal links must be updated manually.

Additional Markdown syntax

For lists, headings, bold/italic text, emojis, collapsible sections, and other standard Markdown features, refer to: