fn6kd-qaaaa-aaaai-act2a-cai.icp0.io Open in urlscan Pro
2a00:fb01:400:200:5000:eeff:fe3d:aa0d  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Skip to main content

My SiteTutorialBlog
GitHub



 * Tutorial Intro
 * Tutorial - Basics
   * Create a Page
   * Create a Document
   * Create a Blog Post
   * Markdown Features
   * Deploy your site
   * Congratulations!
 * Tutorial - Extras

 * 
 * Tutorial - Basics
 * Markdown Features

On this page


MARKDOWN FEATURES

Docusaurus supports Markdown and a few additional features.


FRONT MATTER

Markdown documents have metadata at the top called Front Matter:

my-doc.md

---
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
---

## Markdown heading

Markdown text with [links](./hello.md)





LINKS

Regular Markdown links are supported, using url paths or relative file paths.

Let's see how to [Create a page](/create-a-page).




Let's see how to [Create a page](./create-a-page.md).




Result: Let's see how to Create a page.


IMAGES

Regular Markdown images are supported.

You can use absolute paths to reference images in the static directory
(static/img/docusaurus.png):

![Docusaurus logo](/img/docusaurus.png)






You can reference images relative to the current file as well. This is
particularly useful to colocate images close to the Markdown files using them:

![Docusaurus logo](./img/docusaurus.png)





CODE BLOCKS

Markdown code blocks are supported with Syntax highlighting.

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}
```



src/components/HelloDocusaurus.js

function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}





ADMONITIONS

Docusaurus has a special syntax to create admonitions and callouts:

:::tip[My tip]

Use this awesome feature option

:::

:::danger[Take care]

This action is dangerous

:::



My tip

Use this awesome feature option

Take care

This action is dangerous


MDX AND REACT COMPONENTS

MDX can make your documentation more interactive and allows using any React
components inside Markdown:

export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`You clicked the color ${color} with label ${children}`)
    }}>
    {children}
  </span>
);

This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !

This is <Highlight color="#1877F2">Facebook blue</Highlight> !




This is Docusaurus green !

This is Facebook blue !

Edit this page

Previous
Create a Blog Post
Next
Deploy your site
 * Front Matter
 * Links
 * Images
 * Code Blocks
 * Admonitions
 * MDX and React Components

Docs
 * Tutorial

Community
 * Stack Overflow
 * Discord
 * Twitter

More
 * Blog
 * GitHub

Copyright © 2024 My Project, Inc. Built with Docusaurus.