Skip to content

Component References

Summary

This documentation was built with Astro and starlight. If you would like to create your own beautuful documentation website you ca do so by visiting Starlight website. Prerequisites install Astro website. You can also find this projects source code here.

Markdown Cheat Sheet

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements.

Tabs

Connect

Send me an email

Cards

Stars

Sirius, Vega, Betelgeuse

Moons

Io, Europa, Ganymede

Check this out

Interesting content you want to highlight.
Customizing StarlightLearn how to make your Starlight site your own with custom styles, fonts, and more.

Code snipet

// Javascript code with syntax highlighting.
var fun = function lang(l) {
  dateformat.i18n = require("./lang/" + l);
  return true;
};

Icons

Inline styless

Text can be bold, italic, or strikethrough.

You can link to another page.

You can highlight inline code with backticks.

Images

An illustration of planets and stars featuring the word “astro”

Heading

H1

H2

H3

Bold

bold text

Italic

italicized text

Blockquote

blockquote

Ordered List

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

Unordered List

  • First item
  • Second item
  • Third item

Horizontal Rule


Markdown Guide

Image

alt text

Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Table

SyntaxDescription
HeaderTitle
ParagraphText

Fenced Code Block

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Footnote

Here’s a sentence with a footnote. 1

Strikethrough

The world is flat.

Task List

  • Write the press release
  • Update the website
  • Contact the media

Emoji

That is so funny! 😂

(See also Copying and Pasting Emoji)

Highlight

I need to highlight these very important words

Footnotes

  1. This is the footnote.