Skip to content

Instantly share code, notes, and snippets.

@patrickjohnstevens
Last active December 7, 2022 17:42
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save patrickjohnstevens/e10f2d301ffc8f998126e3c200622e92 to your computer and use it in GitHub Desktop.
Save patrickjohnstevens/e10f2d301ffc8f998126e3c200622e92 to your computer and use it in GitHub Desktop.
MDX Templates
title description sidebar_position authors last_update keywords tags
Meta Title (Recommended < 75 characters)
Meta Description (Recommended < 160 characters)
0
name
Patrick John Stevens
title
Web Developer learning, creating, and teaching. I'm here to serve.
date author
12/06/2022
Patrick John Stevens
keywords separated by commas and surrounded by brackets
e.g. javascript
react
node
tags separated by commas and surrounded by brackets
e.g. javascript
react
node

Title

Subtitle or Description

Overview

This is a summary of the document. It should be a short paragraph that describes the document and its purpose. Many times this is broken down into a few bullet points / elements.

  • Problem. Note the key topic or problem of your document.
  • Method. State your main approach to solving the problem.
  • Results. Provide one or two important results.
  • Conclusion. Note your main conclusion.

If the document isn't finished, the emphasis on this section is placed on the problem and the method. The results and conclusion are left out.

It could use an admonition like this:

:::note Callout with a Note Icon

This is a note icon with a gray box. This is a great way to add a note to your content.

:::

Body

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment