> 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/create-content/formatting/markdown.md). # Markdown Write Markdown directly in the editor to easily create content using common syntax
An image containing the markdown logo

Write Markdown in GitBook.

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` | ### Line breaks Press `Enter` to start a new paragraph. Press `Shift` + `Enter` to insert a soft line break in the same paragraph. ### 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. We use [Prism](https://github.com/PrismJS/prism) for syntax highlighting. Use [Test Drive Prism](https://prismjs.com/test.html#language=markup) to check supported languages. If GitBook and Prism differ, we might be a version or two behind. ### 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. When writing lists, hit `Tab` to indent, and `Shift+Tab` to outdent. ### 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 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://gitbook.com/docs/create-content/formatting/markdown.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.