Documentation

Bookmark this page. Use Ctrl+F (or Cmd+F on Mac) to find what you need. This cheat sheet covers standard Markdown and GitHub-flavored extensions. Try examples at markdownlivepreview.com. Last updated: March 2026 Headings # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6 Text Formatting Markdown Result **bold** bold *italic* italic ***bold and italic*** bold and italic ~~strikethrough~~ strikethrough `inline code` inline code > blockquote blockquote Links and Images [Link text](https://example.com) [Link with title](https://example.com "Hover text") <https://example.com> <!-- auto-link -->   [](https://example.com) <!-- Reference-style links --> [Read more][1] [1]: https://example.com Lists <!-- Unordered --> - Item one - Item two - Nested item - Another nested <!-- Ordered --> 1. First 2. Second 3. Third <!-- Task list (GitHub) --> - [x] Completed task - [ ] Incomplete task - [ ] Another task Code Inline: `const x = 42;` Code block with language: ```javascript function greet(name) { return `Hello ${name}`; } ``` Code block without language: ``` plain text here ``` Supported Languages for Syntax Highlighting javascript, typescript, python, rust, kotlin, java, go, bash, sql, html, css, json, yaml, toml, markdown, diff, dockerfile ...

Your API has many endpoints. Other developers need to know how to use them. They need to know the request format, response format, required headers, and possible error codes. Writing documentation by hand is tedious and quickly becomes outdated. In this tutorial, you will add OpenAPI documentation and Swagger UI to your Ktor API. Developers can browse your API at /docs and try out endpoints directly from the browser. What is OpenAPI? OpenAPI (formerly Swagger) is a standard format for describing REST APIs. It is a YAML or JSON file that lists all endpoints, request bodies, response schemas, authentication, and more. ...