1. Writing Content

Components are reusable building blocks for your documentation. They can be added directly within your files. Some components are rendered from Markdown syntax, while other components work the same way as React components.

Mintlify provides a library of built-in components to make your docs beautiful without formatting things yourself.

Visit our text guide to learn basic markdown syntax.

Examples

Linking to Pages

You can add a link by wrapping text in [](). You would write [link to google](https://google.com) to link to google.

Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, [link to text](/writing-content/text) links to the page “Text” in our components section.

Relative links like [link to text](../text) will open slower because we cannot optimize them as easily.

Using a Component

The following example is a Code component, which lets you display syntax-highlighted code.

class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

It’s rendered using the following code.

```java
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

Creating a callout

To present additional context outside of the main content, you can use a Callout component.

This suggests a helpful tip
<Tip>This suggests a helpful tip</Tip>

Components

There are a variety of components like Accordions, Cards, and tons others that you can explore in the components reference.

Requests

If there are any components that you would like to have but aren’t currently available, contact our team at [email protected].