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 !

jcl

//MTLUSR00 JOB (999,POK),'METAL',CLASS=A,MSGCLASS=H,NOTIFY=&SYSUID
//*
//* BINDER USING THE METAL XPI SAMPLE PROGRAM
//* //LKED     EXEC  PGM=IEWL,REGION=256K,
//UNALIAS   EXEC  PGM=IKJEFT01
//SYSTSPRT  DD    SYSOUT=X
//SYSTSIN   DD    *
  DELETE 'hlq.SCXPEXEC(JCLXPERT)'
/*
//ALIAS     EXEC  PGM=IKJEFT01
//SYSTSPRT  DD    SYSOUT=X
//SYSTSIN   DD    *
  RENAME -
    'hlq.SCXPEXEC(CXPXPERT)' -
    'hlq.SCXPEXEC(JCLXPERT)' -
     ALIAS
/*
//JCLXPERT EXEC PGM=CXPJCLB,PARM='/OUTPUT=TEXT'
//STEPLIB  DD DSN=&HLQ..SCXPLOAD,DISP=SHR
//CXPNLSDD DD PATH='&CXPPATH./nls/english.txt'
//INDD     DD DSN=&HLQ..SCXPSAMP(CXPS0202),DISP=SHR
//SYSPRINT DD SYSOUT=*
//

/**************************** REXX *********************************/
/* This program adds two numbers and produces their sum.           */
/**********************************
*********************************/
say 'Enter first number.'
PULL number1                                /* Assigns: number1=42 */
say 'Enter second number.'
PULL number2                                /* Assigns: number2=21 */
sum = number1 + number2
SAY 'The sum of the two numbers is' sum'.'

/* REXX */
env  = 'ENV(REXX)' 
result  = 'RESULT(?)'
ADDRESS LINKMVS "CAZ2LPDS env result”
SAY 'CAZ2LPDS RC=' || rc
SAY result
DO WHILE QUEUED() > 0 
  PULL text  
  SAY 'Stack>' text
END 
EXIT RC