Skip to main content

Benjamin
Charity

Published: January 1, 2045
Updated: October 16, 2025

Markdown Test Document

Reading time: 4min

Creating a comprehensive Markdown page that includes all possible GitHub Markdown elements can serve as an invaluable resource for documentation, project READMEs, and more. Below is an example of such a Markdown page, showcasing a wide array of elements such as headings, emphasis, lists, links, images, code blocks, tables, blockquotes, and more.

Project Title

Table of Contents

Introduction

Welcome to the project! This document demonstrates various GitHub Markdown elements to help you create rich documents.

Text

Headings

Use # for a level 1 heading, ## for level 2, and so on up to ###### for level 6.

Emphasis

  • Bold with ** or __.
  • Italic with * or _.
  • Strikethrough with ~~.

Callout

Here is a paragraph with a callout marker in the middle.

Colors

Don't forget to check colors like #bada55 and #c0ffee!

Lists

Ordered List

  1. First item
  2. Second item
  3. Third item

Unordered List

  • Item
  • Another item
  • Yet another item

Images

An alt description for this image.
A custom caption!

Bridget Jones testing microphone GIF

Code

Inline Code

Use single backticks: var example = true;

This is an array [1, 2, 3] of numbers 1 through 3.

Code Block

function test() {
  console.log('Standard output');
}

Line Highlighting

function test() {
  console.log('notice I am highlighted?');
}
function test() {
  console.log('notice I am highlighted?');
  console.log('and, so am I!');
}
function test() {
  console.log('one');
  console.log('two');
  console.log('three');
  console.log('four');
  console.log('five');
  console.log('six');
}

Highlight word

function test() {
  console.log('notice that test is highlighted?');
}
// [!code word:options:2]
const options = { foo: 'bar' };
options.foo = 'baz';
console.log(options.foo); // this one will not be highlighted

Highlight by IDs

const [age, setAge] = useState(50);
const [name, setName] = useState('Taylor');
const [email, setEmail] = useState('taylor@example.com');
const ab = 12;
const abcd = 1234;

Diff

export function foo() {
  console.log('hewwo'); // [!code --]
  console.log('hello'); // [!code ++]
}
export function foo() {
  -console.log('hewwo');
  +console.log('hello');
}

Title & caption

// Code
// Code

Tables

Syntax Description Left-aligned Center-aligned Right-aligned
Header Title Cell 1 Cell 2 Cell 3
Paragraph Text Cell 4 Cell 5 Cell 6

Blockquotes

Blockquotes can also be nested.

Like this.

Horizontal Rules

Three or more...


Hyphens


Asterisks


Underscores

Task Lists

  • Write the documentation
  • Update the website

Mentioning Users and Teams

@username or @teamname will notify the person or team mentioned.

Content References

#1, @user, and other references allow linking to issues, PRs, and users.

Using Emojis

:smiley: Add emojis with :EMOJI_CODE:

Collapsible Sections

Click to expand! Here's more detailed information.

This Markdown page example covers the basics and some advanced elements, making it a good starting point for your documents on GitHub. Feel free to expand it with more specific sections tailored to your project's needs.

Build, Scale, Succeed

Join others receiving expert advice on
engineering and product development.

Newsletter Subscription

No data sharing. Unsubscribe at any time.