https://github.com/ktorio/ktor-documentation

Documentation for the Ktor framework.
https://github.com/ktorio/ktor-documentation

documentation kotlin ktor ktor-client ktor-framework ktor-server

Last synced: 3 days ago
JSON representation

Documentation for the Ktor framework.

• Host: GitHub
• URL: https://github.com/ktorio/ktor-documentation
• Owner: ktorio
• License: apache-2.0
• Created: 2020-07-10T07:50:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-09T09:40:45.000Z (13 days ago)
• Last Synced: 2025-01-13T02:00:39.443Z (10 days ago)
• Topics: documentation, kotlin, ktor, ktor-client, ktor-framework, ktor-server
• Language: Kotlin
• Homepage: https://ktor.io/docs/welcome.html
• Size: 77.8 MB
• Stars: 450
• Watchers: 14
• Forks: 299
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Ktor Documentation

[![Official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)

Welcome to the repository containing documentation of the [Ktor](https://ktor.io) framework, published

on [https://ktor.io/docs/](https://ktor.io/docs/).

## Project organization

This project is built with [Writerside](https://www.jetbrains.com/help/writerside/discover-writerside.html) and has the

following project structure:

* `/cfg` contains configuration files.

* `/codeSnippets` contains a Gradle project with runnable code samples demonstrating Ktor

  capabilities. To learn how to run the samples and reference them in topics, see

  the [Code Snippets Doc](codeSnippets/README.md).

* `/images` contains images and GIFs used in topics.

* `/templates` has a single `settings.zip` file containing IntelliJ IDE settings.

* `/topics` contains documentation files in Markdown and XML.

* `ktor.tree` defines the table of contents.

* `c.list` contains a list of categories that define groups of related links for the 'See also' section of a topic.

* `v.list` contains a list of global project variables.

## Contribute

We welcome and encourage various types of contributions to the Ktor Docs.

If you'd like to contribute, but don't know where to start, take a look at the [open issues

on YouTrack](https://youtrack.jetbrains.com/issues/KTOR?q=Subsystem:%20Docs%20%20State:%20Submitted%20%20Type:%20Bug).

### Submit contributions

You can find detailed information about contributing and submitting a pull request in

our [Contribution Guidelines](/CONTRIBUTING.md).

### Report bugs or propose features

If you find a bug in this repo or have a feature request that hasn't already been reported, we invite you to [create a

new issue on YouTrack](https://youtrack.jetbrains.com/issues/KTOR?q=Subsystem:%20Docs%20)

or [contribute](/CONTRIBUTING.md)

to this repo.

### Give us feedback

At the bottom of each documentation page published on [ktor.io/docs](https://ktor.io/docs/) you will find a **'Was this

page helpful?'** prompt:

  

  

  

You have two options:

- Select **Yes** to automatically send us positive feedback.

- Select **No** to open and fill out a feedback form. Make sure to give as much detail as possible.

The Ktor team consistently reviews and addresses received feedback.

## Thank you

Thank you for being a part of our community :orange_heart:!

We appreciate your support and efforts towards improving Ktor and Ktor Documentation.

## Support

For any Ktor-related support questions, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/ktor).

For peer to peer support, use

the [Ktor channel on Slack](https://app.slack.com/client/T09229ZC6/C0A974TJ9) ([request access](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up?_ga=2.60121645.1248821053.1699374860-51549079.1696935532&_gl=1*1u9h2dl*_ga*NTE1NDkwNzkuMTY5NjkzNTUzMg..*_ga_9J976DJZ68*MTY5OTUyNTQ4MS4xNTcuMS4xNjk5NTI1ODgyLjYwLjAuMA..)).