GitBook’s editor allows you to create formatted content using Markdown.
Markdown is a popular markup syntax that’s widely known for its simplicity. GitBook supports it as a keyboard-friendly way to write rich and structured text.
{% hint style="info" %}
You can learn more about Markdown itself by visiting [Common Mark](https://commonmark.org/help/).
{% endhint %}
### Text formatting
GitBook supports all the classic inline Markdown formatting:
| Formatting | Markdown version | Result |
| ------------- | ----------------- | ----------------- |
| Bold | `**bold**` | **bold** |
| Italic | `_italic_` | *italic* |
| Strikethrough | `~strikethrough~` | ~~strikethrough~~ |
| Inline code | `` `code` `` | `code` |
### Pasting Markdown
When pasting Markdown content directly into the editor, it’s important to use the **Paste and Match Style** option (typically Shift + Cmd + V on Mac or Shift + Ctrl + V on Windows).
If you use the standard Paste option for content copied from another editor or from the web, it may be inserted as a code block instead of formatted text.
### Titles
* Heading 1: `# A first-level title`
* Heading 2: `## A second-level title`
* Heading 3: `### A third-level title`
### Code blocks
` ```⏎ ` creates a new code block.
` ```py⏎ ` creates a new code block with Python syntax highlighting.
{% hint style="info" %}
We use [Prism](https://github.com/PrismJS/prism) for syntax highlighting. You can use [Test Drive Prism](https://prismjs.com/test.html#language=markup) to check which languages Prism supports. If you notice a mismatch between GitBook and Prism, there’s a chance we’re a version or two behind. We’ll catch up soon!
{% endhint %}
### Lists
GitBook automatically detects and creates ordered and unordered lists as you type.
* Begin a line with `-` or `*` to start an unordered bullet list.
* Begin a line with `1.` to start a numbered list.
* Begin a line with `- [ ]` to start a task list.
{% hint style="info" %}
When writing any kind of list, hit `Tab` to add a indent, and `Shift+Tab` to outdent.
{% endhint %}
### Quotes
Begin a line with `>` to create a block quote. If you select an entire paragraph from start to end, typing `>` will wrap the content in a block quote.
> This is a block quote.
### Dividers
Type `---` then hit `Enter` to create a divider on your page.
***
This is an example of a divider.
---
# Agent Instructions: 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:
```
GET https://gitbook.com/docs/creating-content/formatting/markdown.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.
