Skip to main content

Markdown Features

Community-Library 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)

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.

Add an image at static/img/logo.png and display it in Markdown:

![Community-Library logo](/img/undraw_logo.svg)

Community-Library logo

Code Blocks​

Markdown code blocks are supported with Syntax highlighting.

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

Admonitions​

Community-Library 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="#fd0000">StackUp Orange</Highlight> !

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

This is StackUp Orange !

This is Facebook blue !