> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/integrations/guides/markdown.md).

# Reference your component in markown

This guide maps a fenced code block to your custom component. After Git Sync imports the Markdown file, GitBook renders the component in the page.

### Before you begin

Before you start, make sure that:

* Your integration defines a custom block in `gitbook-manifest.yaml`.
* Your repository syncs with Git Sync.

### Map the code block

In `gitbook-manifest.yaml`, add a `markdown` mapping to the block:

```yaml
blocks:
  - id: block-name
    title: My custom block
    markdown:
      codeblock: blocksyntax
      body: content
```

The `codeblock` value identifies the Markdown fence. The `body` value identifies the component property that receives the fence content.

### Add the component to Markdown

In a Markdown file that Git Sync imports, add a fenced code block:

````markdown
```blocksyntax
something
```
````

GitBook creates your custom block with `content` set to `something`.

### Pass additional properties

Add properties after the fence name when your component needs more values:

````markdown
```blocksyntax propA="A"
something
```
````

GitBook sets `content` to `something` and `propA` to `A`.

### Sync and verify

1. Commit and push the manifest and Markdown changes.
2. Wait for Git Sync to import the commit.
3. Open the synced page in GitBook.

GitBook renders the fenced block as your custom component.

For custom block configuration, see [Configure your integration](/docs/developers/integrations/configurations.md#blocks). For component rendering, see the [Component reference](/docs/developers/integrations/development/contentkit/reference.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook.com/docs/developers/integrations/guides/markdown.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
