dokka

(β˜… 3,801)

API documentation engine for Kotlin

File Explorer

Download Latest Version (.zip)

Showing a partial file list β€” download the zip above to see everything.

  • .gitattributes
  • .gitignore
  • build.gradle.kts
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE.txt
  • NOTICE.txt
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/Kotlin/dokka

Downloads the entire project code from GitHub to your computer.

cd dokka

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd build-logic

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r docs-developer/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Today's picks

cs-video-courses β˜… 83,059

List of Computer Science courses with video lectures.
Agent-Reach β˜… 72,282

Give your AI agent eyes to see the entire internet. Read & search Twitter, Reddit, YouTube

Python
create-react-app β˜… 103,294

Set up a modern web app by running one command.

JavaScript
opencv β˜… 90,456

Open Source Computer Vision Library

C++
moby β˜… 71,980

The Moby Project - a collaborative project for the container ecosystem to assemble contain

Go
ohmyzsh β˜… 189,228

πŸ™ƒ A delightful community-driven (with 2,500+ contributors) framework for managing your z

Shell
// repository documentation