Skip to content

Commit

Permalink
updating docs for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
daanx committed Feb 7, 2022
1 parent 56477c2 commit eba73ff
Show file tree
Hide file tree
Showing 18 changed files with 153 additions and 97 deletions.
20 changes: 20 additions & 0 deletions doc/spec/book-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@ adown: []{.fa .fa-angle-double-down}
aup: []{.fa .fa-angle-double-up}
acopy: []{.fa .fa-copy}

logo-ubuntu: []{.fa-brands .fa-ubuntu}
logo-suse: []{.fa-brands .fa-suse}
logo-rhel: []{.fa-brands .fa-redhat}
logo-alpine: ![logo-alpine]
logo-arch: ![logo-arch]
logo-debian: ![logo-debian]
logo-freebsd: ![logo-freebsd]
logo-macos: []{.fa-brands .fa-apple}
logo-windows: []{.fa-brands .fa-windows}
logo-linux: []{.fa-brands .fa-linux}

.title {
font-size: xxx-large;
}
Expand Down Expand Up @@ -36,6 +47,15 @@ toc.toc-contents {
.button;
}

.small-button {
.button
}

.download-button {
.small-button
.localref
}

.copy {
float: left;
font-size: 75%;
Expand Down
3 changes: 2 additions & 1 deletion doc/spec/book.kk.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ Heading Depth : 3
Toc Depth : 3
Css : styles/koka.css
Css : styles/book.css
Css : https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css
Css : https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
Css : https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/brands.min.css
Script : scripts/book.js
Colorizer : unchecked
Colorizer : koka
Expand Down
39 changes: 3 additions & 36 deletions doc/spec/getstarted.kk.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<!-- #00547D -->
<!--
[<img align="right" src="https://badges.gitter.im/koka-lang/koka.svg"/>](https://gitter.im/koka-lang/koka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

-->

# Getting started { #getstarted; }

Expand Down Expand Up @@ -43,41 +44,7 @@ libraries, package management, and deep IDE integration.

## Installing the compiler { #install }

For Linux (x64, arm64), macOS (x64, M1), and FreeBSD (x64), you can install &koka; using:

&acopy;
{.copy; data-value:"curl -sSL https://github.com/koka-lang/koka/releases/latest/download/install.sh | sh"}

\(**curl -sSL https://github.com/koka-lang/koka/releases/latest/download/install.sh &bar; sh**\)

For Windows (x64), open a ``cmd`` prompt and use:

&acopy;
{.copy; data-value:"curl -sSL -o %tmp%\install-koka.bat https://github.com/koka-lang/koka/releases/latest/download/install.bat && %tmp%\install-koka.bat"}

\(**curl -sSL -o %tmp%\install-koka.bat https://github.com/koka-lang/koka/releases/latest/download/install.bat && %tmp%\install-koka.bat**\)

This also installs syntax highlighting for the VS Code and Atom editors.

After installation, verify if &koka; installed correctly:

$ koka
_ _
| | | |
| | _ ___ | | _ __ _
| |/ / _ \| |/ / _' | welcome to the koka interactive compiler
| ( (_) | ( (_| | version 2.3.1, Sep 21 2021, libc x64 (gcc)
|_|\_\___/|_|\_\__,_| type :? for help, and :q to quit

loading: std/core
loading: std/core/types
loading: std/core/hnd
>

Type ``:q`` to exit the interactive environment.

For detailed installation instructions and other platforms see the [releases] page.
It is also straightforward to build the compiler [from source][build].
[INCLUDE=install]

## Running the compiler

Expand Down
1 change: 1 addition & 0 deletions doc/spec/images/logo-alpine.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions doc/spec/images/logo-arch.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/spec/images/logo-debian.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions doc/spec/images/logo-freebsd.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 3 additions & 34 deletions doc/spec/index.kk.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,9 @@ body {


[![koka-logo]](book.html){float:left; margin-right:1em;}
<!--
[<img align="right" src="https://badges.gitter.im/koka-lang/koka.svg"/>](https://gitter.im/koka-lang/koka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-->

~ heading-title
[Koka]{font-size:200%; font-weight:bold; display:inline-block; padding-top:0.45em; }\
Expand Down Expand Up @@ -209,41 +211,8 @@ algorithms in a functional style.
~

~ begin content
For Linux (x64, arm64), macOS (x64, M1), and FreeBSD (x64), you can install &koka; using:

&acopy;
{.copy; data-value:"curl -sSL https://github.com/koka-lang/koka/releases/latest/download/install.sh | sh"}

\(**curl -sSL https://github.com/koka-lang/koka/releases/latest/download/install.sh &bar; sh**\)

For Windows (x64), open a ``cmd`` prompt and use:

&acopy;
{.copy; data-value:"curl -sSL -o %tmp%\install-koka.bat https://github.com/koka-lang/koka/releases/latest/download/install.bat && %tmp%\install-koka.bat"}

\(**curl -sSL -o %tmp%\install-koka.bat https://github.com/koka-lang/koka/releases/latest/download/install.bat && %tmp%\install-koka.bat**\)

This also installs syntax highlighting for the VS Code and Atom editors.

After installation, verify if &koka; installed correctly:

$ koka
_ _
| | | |
| | _ ___ | | _ __ _
| |/ / _ \| |/ / _' | welcome to the koka interactive compiler
| ( (_) | ( (_| | version 2.1.7, Jun 15 2021, libc x64 (gcc)
|_|\_\___/|_|\_\__,_| type :? for help, and :q to quit

loading: std/core
loading: std/core/types
loading: std/core/hnd
>

Type ``:q`` to exit the interactive environment.

For detailed installation instructions and other platforms see the [releases] page.
It is also straightforward to build the compiler [from source][build].
[INCLUDE=install]

[Get started with the compiler](book.html#sec-running-the-compiler){.learn}

Expand Down
59 changes: 59 additions & 0 deletions doc/spec/install.mdk
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
[ubuntu-x64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-ubuntu-x64.deb {.localref}
[alpine-x64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-alpine-x64.apk {.localref}
[rhel-x64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-rhel-x64.rpm {.localref}
[arch-x64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-arch-x64.pkg.tar.zst {.localref}
[opensuse-x64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-opensuse-x64.rpm {.localref}

[ubuntu-arm64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-ubuntu-arm64.deb {.localref}
[alpine-arm64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-alpine-arm64.apk {.localref}
[rhel-arm64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-rhel-arm64.rpm {.localref}
[arch-arm64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-arch-arm64.pkg.tar.zst {.localref}
[opensuse-arm64]: https://github.com/koka-lang/koka/releases/download/v2.4.0/koka-v2.4.0-opensuse-arm64.rpm {.localref}

[logo-alpine]: images/logo-alpine.svg { height: 1em; vertical-align: -0.2ex; }
[logo-arch]: images/logo-arch.svg { height: 1em; vertical-align: -0.2ex; }
[logo-debian]: images/logo-debian.svg { height: 1em; vertical-align: -0.4ex; }
[logo-freebsd]: images/logo-freebsd.svg { height: 0.8em; vertical-align: -0.2ex; }

On Windows (x64), open a ``cmd`` prompt and use:

&acopy;
{.copy; data-value:"curl -sSL -o %tmp%\install-koka.bat https://github.com/koka-lang/koka/releases/latest/download/install.bat && %tmp%\install-koka.bat"}

\(**curl -sSL -o %tmp%\install-koka.bat https://github.com/koka-lang/koka/releases/latest/download/install.bat && %tmp%\install-koka.bat**\)

On Linux (x64, arm64), macOS (x64, M1), and FreeBSD (x64), you can install &koka; using:

&acopy;
{.copy; data-value:"curl -sSL https://github.com/koka-lang/koka/releases/latest/download/install.sh | sh"}

\(**curl -sSL https://github.com/koka-lang/koka/releases/latest/download/install.sh &bar; sh**\)

There are also installation packages for various Linux distributions:
Ubuntu/Debian ([x64][ubuntu-x64], [arm64][ubuntu-arm64]),
Alpine ([x64][alpine-x64], [arm64][alpine-arm64]),
Arch ([x64][arch-x64], [arm64][arch-arm64]),
Red Hat ([x64][rhel-x64]), and
openSUSE ([x64][opensuse-x64]).
{text-align:left}

After installation, verify if &koka; installed correctly:

$ koka
_ _
| | | |
| | _ ___ | | _ __ _
| |/ / _ \| |/ / _' | welcome to the koka interactive compiler
| ( (_) | ( (_| | version 2.4.0, Feb 7 2022, libc x64 (gcc)
|_|\_\___/|_|\_\__,_| type :? for help, and :q to quit

loading: std/core
loading: std/core/types
loading: std/core/hnd
>

Type ``:q`` to exit the interactive environment.

For detailed installation instructions and other platforms see the [releases] page.
It is also straightforward to build the compiler [from source][build].

18 changes: 13 additions & 5 deletions doc/spec/news.mdk
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
~ begin news
News:

* 2021-02-04 (pinned) The [Context Free](https://www.youtube.com/channel/UCS4FAVeYW_IaZqAbqhlvxlA)
youtube channel posted a short and fun [video](https://www.youtube.com/watch?v=olISecOUX1g&t=959s)
about effects in Koka (and 12 (!) other languages).

* 2021-09-01 (pinned) The ICFP'21 tutorial
"_Programming with Effect Handlers and FBIP in Koka_" is now available on
[youtube](https://www.youtube.com/watch?v=6OFhD_mHtKA).

* 2022-02-07: Koka v2.4.0 released: improved specialization and `int` operations, add `rbtree-fbip` sample,
improve grammar (`pub` (instead of ``public``, remove private (as everything is private by default now)),
`final ctl` (instead of `brk`), underscores in number literals, etc), rename `double` to `float64`, various bug fixes.

* 2021-12-27: Koka v2.3.8 released: improved `int` performance, various bug fixes, update wasm backend,
initial conan support, fix js backend.

Expand Down Expand Up @@ -58,9 +66,9 @@ News:
* 2020-11-29: Perceus technical report publised ([pdf][Perceus]).
{.news-items}

[released]: https://koka-lang.github.io/koka/doc/book.html#install
[emscripten]: https://emscripten.org/docs/getting_started/downloads.html
[musl]: https://musl.libc.org/
[wasmtime]: https://wasmtime.dev/
~ end news

~ end news
[released]: https://koka-lang.github.io/koka/doc/book.html#install
[emscripten]: https://emscripten.org/docs/getting_started/downloads.html
[musl]: https://musl.libc.org/
[wasmtime]: https://wasmtime.dev/
9 changes: 8 additions & 1 deletion doc/spec/styles/book.css
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ table .kw, table .tp, table .co,
padding: 1ex;
transition: all 0.25s;
cursor: pointer;
margin-top: 0ex;
border-radius: 1ex;
}

Expand All @@ -150,7 +149,15 @@ table .kw, table .tp, table .co,
background-color: #b9dae8 !important;
}

.small-button.button {
padding: 0.25ex 1ex;
transition: all 0.25s;
cursor: pointer;
margin: 0.25ex 0ex;
}

a.button, .button a {
color: black;
text-decoration: none !important;
}

Expand Down
Loading

0 comments on commit eba73ff

Please sign in to comment.