---
title : Quick Start Guide
description : a quick way to understand how to use it
date : 10-12-2024
---

## Heading 2

this is regular text written in markdown format with `inline code`, **bold**, and *italic*

### Heading 3

example of ordered list format :

- list one
        - sub list
- list two
- list three

#### Heading 4

Below is an example of how to write a code block :

````plaintext
```javascript:main.js showLineNumbers {3-4}
function isRocketAboutToCrash() {
    // Check if the rocket is stable
    if (!isStable()) {
        NoCrash(); // Prevent the crash
    }
}
```
````

example note :
```plaintext
<Note type="note" title="Note">
  This is a general note to convey information to the user.
</Note>
```

displaying an image in markdown format :

```plaintext
![Alt text for the image](/images/example-img.png)
```

render as :
![Alt text for the image](/images/example-img.png)

For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.

<Note type="warning" title="Warning">
  every page that is indexed in a folder will have an `index.mdx` file with metadata :
  ```plaintext
---
title : Introduction
description : overview or synopsis of a project
date : 10-12-2024
image : example-img.png
---
  ```
</Note>