Skip to content
The Kotlin Programming Language Website
JavaScript CSS HTML Python Shell XSLT Dockerfile
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea Added 28 Kotlin talks and 6 UGs Jan 19, 2018
assets fix: Inter font loading fix Feb 12, 2020
data fix: typo in an event link Feb 19, 2020
external fix(kopy): drop unused file Dec 11, 2018
kotlin-features chore(index): normalize why section Feb 12, 2020
pages-includes/docs/tutorials/native chore: Native tutorials cleanup (#1560) Feb 4, 2020
pages chore: convert examples in basic-types.md to runnable (#1598) Feb 22, 2020
pdf chore(pdf): increase the zoom Nov 22, 2018
scripts fix: support new api for yandex geocoder (#1506) Nov 5, 2019
src fix(search): make search great again Jul 3, 2019
static Revert "Revert "chore(index): new kotlinconf 2020 banner"" Feb 20, 2020
templates Revert "Revert "chore(index): new kotlinconf 2020 banner"" Feb 20, 2020
tests Move visual-regression tests dependencies to separate package Aug 11, 2017
.babelrc Migrate to webpack 3 Aug 16, 2017
.dockerignore Fix missing navigation & other fixes (#1110) Sep 10, 2018
.env.sample Use Docker as dev environment Feb 12, 2018
.gitignore feat(ignores): exclude macOS .DS_Store folders from Git May 3, 2019
.npmrc Use webpack for asset building. Oct 26, 2016
.nvmrc Bump Node.js version in .nvmrc Aug 16, 2017
Dockerfile feat(generator): clearly parse all script arguments in one place, sup… Mar 21, 2019
LICENSE Add missing license file Apr 28, 2017
README.md Fix README to point to correct data folder. (#1246) Jan 3, 2019
build-assets.sh feat(scripts): additional scripts to start and simplify development Dec 5, 2018
build-devserver.sh feat(generator): clearly parse all script arguments in one place, sup… Mar 21, 2019
docker-compose.yml Use Docker as dev environment Feb 12, 2018
kotlin-website.py Merge pull request #1562 from hltj/digest_asset_version Feb 14, 2020
mysettings.py feat(tutorial): K/N code is downloaded from GitHub and included into … May 3, 2019
package.json chore(deps): update kotlin-playground Oct 4, 2019
postcss.config.js Migrate to webpack 4 Jan 18, 2019
requirements.txt fix: support new api for yandex geocoder (#1506) Nov 5, 2019
robots.txt robots.txt added Jun 16, 2014
wdio.conf.js JS-5532 Visual regression testing for Kotlin site Apr 12, 2017
webpack.config.js feat(index): add techs links Feb 12, 2020
yarn.lock chore(deps): bump fstream from 1.0.11 to 1.0.12 Jan 17, 2020

README.md

Kotlin website

Official project Slack

This is the source for the http://kotlinlang.org.

Installation

  1. You will need Docker to run site lifecycle tasks. Installation for macOS and Windows.
  2. If you want to develop frontend Yarn package manager is also needed (installation instructions). Don't forget to install frontend dependencies - yarn install.
  3. All specific app parameters stored in env-file. Copy sample file .env.sample and rename it to .env. Change variables values if needed.

How to run

  • All in one option (suitable for content authors/writers):
    • docker-compose up. It will build all stuff and create site on localhost:5000.
  • Developer has 2-step option:
    • docker-compose up website will run only site at localhost:5000.
    • yarn start will run webpack-dev-server on localhost:9000. This address should be used for development. All pages from origin server will be proxied.

Project structure & overview

Data

All data is stored in the *.yml files in folder data:

  • _nav.yml site navigation and PDF building.
  • releases.yml info about releases.
  • videos.yml data for the Videos page. The content property is used to create categories. It contains a list of videos or other categories. Maximum tree depth level is 3.
  • events.xml event data.

Templates

Kotlinlang uses Jinja2 templates that can be found in templates folder. Note that all Markdown files are processed as Jinja templates before being converted to HTML. This allows you to use all Jinja power inside Markdown (for example, build urls with url_for function).

Page metadata

Every page can have an unlimited number of metadata fields. More information here. The most important of them are the page template (e.g. layout: reference) and its type (e.g. type: tutorial). category and title fields are added for future development.

Kotlin grammar reference

The Kotlin grammar reference (grammar.xml) is generated by the Kotlin grammar generator from the Kotlin grammar definition.

Writing content

Markup

kramdown with some additions (like GitHub fenced code blocks) is used as Markdown parser. See the complete syntax reference at the kramdown site.

Specifying page element attributes

With kramdown you can assign HTML attributes to page elements via {:%param%}. E.g.:

  • *important text*{:.important} - produces <em class="important">important text</em>
  • *important text*{:#id} - produces <em id="id">important text</em>

For block elements this instruction must be specified on the line following element definition:

This is a paragraph
{:.important}

This is a paragraph

More information about attributes can be found here.

Custom element styles

Inline elements

  • {:.keyword} highlights a keyword.
  • {:.error} highlights an error.
  • {:.warning} highlights a warning.

Tables

  • {:.wide} stretches a table to occupy the entire width of a page.
  • {:.zebra} interleaves table rows.

E.g.:

| Expression | Translated to |
|------------|---------------|
| `a++` | `a.inc()` + see below |
| `a--` | `a.dec()` + see below |
{:.wide.zebra}

Quotation blocks

They're used in a slightly other manner that they were originally designed for: as universal block container elements.

  • {:.note} highlights a note block.

E.g.:

> **`inc()/dec()` shouldn't mutate the receiver object**.
>
> By "changing the receiver" we mean `the receiver-variable`, not the receiver object.
{:.note}

Filing Bugs

We use YouTrack for bug reports and suggestions. Click here to report an issue.

You can’t perform that action at this time.