---
title: List a guide on docs.marco.finboot.com
---

Learn how to list a guide on the [MARCO guides](https://docs.marco.finboot.com/guides) page.

## 1. Clone the repository

The first step is to clone the repository [marco-docs](https://gitlab.com/finboot/it-applications/david-garcia/marco-docs) locally.
For more information, see [Clone a repository](https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html#clone-a-repository).

## 2. Create a new file

Guides live under the `source/guides` folder.
To list a new guide, create a new `.md` file under this folder.

For example:

```
touch source/guides/hello-world.md
```

## 3. Complete the metadata

Add the following lines at the top of the file you have created.

```
---
title: Hello world
description: One-line description for this guide.
tags: [java sdk,smart contracts]
externalUrl: https://java-docs.marco.finboot.com/guides/hello-world
---
```

Then, edit the metadata as follows:

| Key           | Range of values | Description                                                                      |
|---|---|---|
| `title`  |       | The title of the guide.  |
| `description` |                 | A one-line description that explains what the user will learn. |
| `tags` | **Clients**: <ul><li>api</li><li>java sdk</li><li>javascript sdk</li><li>console</li></ul> **Topics**:  <ul><li>accounts</li><li>smart contracts</li><li>ledgers</li><li>wallets</li><li>idps</li><li>marpps</li><li>plugin</li><li>projects</li></ul> | List of tags assigned to the guide, separated by commas. |
| `external_url` | | (Optional) Set this key with an URL if the conent of your guide lives on a separate repo. Otherwise, you can write the content of the guide in the same Markdown page. |


## 4. Submit a pull request

Create a new branch, commit the changes, and send a new pull request. Once it gets merged, you will see the guide listed on the [MARCO guides](https://docs.marco.finboot.com/guides) page.