skip to content
Arthifact Logo Arthifact

A post of Markdown elements

/ 3 min read

Updated:
Table of Contents

This is a H2 Heading

This is a H3 Heading

This is a H4 Heading

This is a H5 Heading
This is a H6 Heading

Horizontal Rules




Emphasis

This is bold text

This is italic text

Strikethrough

Quotes

“Double quotes” and ‘single quotes’

Blockquotes

Blockquotes can also be nested…

…by using additional greater-than signs right next to each other…

References

An example containing a clickable reference1 with a link to the source.

Second example containing a reference2 with a link to the source.

If you check out this example in src/content/post/markdown-elements/index.md, you’ll notice that the references and the heading “Footnotes” are added to the bottom of the page via the remark-rehype plugin.

Lists

Unordered

  • Create a list by starting a line with +, -, or *
  • Sub-lists are made by indenting 2 spaces:
    • Marker character change forces new list start:
      • Ac tristique libero volutpat at
      • Facilisis in pretium nisl aliquet
      • Nulla volutpat aliquam velit
  • Very easy!

Ordered

  1. Lorem ipsum dolor sit amet

  2. Consectetur adipiscing elit

  3. Integer molestie lorem at massa

  4. You can use sequential numbers…

  5. …or keep all the numbers as 1.

Start numbering with offset:

  1. foo
  2. bar

Code

Inline code

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code

Block code “fences”

Sample text here...

Syntax highlighting

var foo = function (bar) {
return bar++;
};
console.log(foo(5));

Expressive code examples

Adding a title

file.js
console.log("Title example");

A bash terminal

Terminal window
echo "A base terminal example"

Highlighting code lines

line-markers.js
function demo() {
console.log("this line is marked as deleted");
// This line and the next one are marked as inserted
console.log("this is the second inserted line");
return "this line uses the neutral default marker type";
}

Expressive Code can do a ton more than shown here, and includes a lot of customisation.

Tables

OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.

Table Alignment

ItemPrice# In stock
Juicy Apples1.99739
Bananas1.896

Keyboard elements

ActionShortcut
Vertical splitAlt+Shift++
Horizontal splitAlt+Shift+-
Auto splitAlt+Shift+d
Switch between splitsAlt + arrow keys
Resizing a splitAlt+Shift + arrow keys
Close a splitCtrl+Shift+W
Maximize a paneCtrl+Shift+P + Toggle pane zoom

Images

Image in the same folder: src/content/post/markdown-elements/logo.png

Astro theme cactus logo

Content from markdown-it

What are admonitions

Admonitions (also known as “asides”) are useful for providing supportive and/or supplementary information related to your content.

How to use them

To use admonitions in Astro Cactus, wrap your Markdown content in a pair of triple colons :::. The first pair should also include the type of admonition you want to use.

For example, with the following Markdown:

:::note
Highlights information that users should take into account, even when skimming.
:::

Outputs:

Admonition Types

The following admonitions are currently supported:

  • note
  • tip
  • important
  • warning
  • caution

Note

:::note
Highlights information that users should take into account, even when skimming.
:::

Tip

:::tip
Optional information to help a user be more successful.
:::

Important

:::important
Crucial information necessary for users to succeed.
:::

Caution

:::caution
Negative potential consequences of an action.
:::

Warning

:::warning
Critical content demanding immediate user attention due to potential risks.
:::

Customising the admonition title

You can customise the admonition title using the following markup:

:::note[My custom title]
This is a note with a custom title.
:::

Outputs:

GitHub Repository Cards

You can add dynamic cards that link to GitHub repositories, on page load, the repository information is pulled from the GitHub API.

Lorem ipsum dolor sit amet, consectetur adipiscing elit.
00K00KMIT

You can also link a Github user:

00K00K

To use this feature you just use the “Github” directive:

Linking a repo
::github{repo="chrismwilliams/astro-theme-cactus"}
Linking a user
::github{user="withastro"}

Footnotes

  1. Reference first footnote with a return to content link.

  2. Second reference with a link.