Skip to content
Snippets Groups Projects
Commit a53d36c1 authored by Janne Mareike Koschinski's avatar Janne Mareike Koschinski
Browse files

Updated example

parent 751567d8
No related branches found
No related tags found
No related merge requests found
......@@ -5,28 +5,61 @@ Welcome to the Quasseldroid documentation!
!!! danger
The documentation is still being worked on, currently all content is placeholder content.
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs help` - Print this help message.
## Examples
## Project layout
### Text example
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
This is an example for a normal text.
Some text
### Code example
```kotlin
package de.kuschku.libquassel.util.irc
object HostmaskHelper {
fun nick(mask: String): String {
val (nick, _, _) = split(mask)
return nick
}
fun user(mask: String): String {
val (_, user, _) = split(mask)
return user
}
fun host(mask: String): String {
val (_, _, host) = split(mask)
return host
}
fun split(mask: String): Triple<String, String, String> {
val userPartHostSplit = mask.split("@", limit = 2)
if (userPartHostSplit.size < 2)
return Triple(mask, "", "")
val (userPart, host) = userPartHostSplit
val nickUserSplit = userPart.split('!', limit = 2)
if (nickUserSplit.size < 2)
return Triple(mask, "", host)
val (nick, user) = nickUserSplit
return Triple(nick, user, host)
}
}
```
### Inline Code Example
This is inline `#!js var test=0;` code highlighting.
### Formula Example
$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
Y = \lambda f.(\lambda x.f(x x)) (\lambda x.f (x x))
$$
Lorem ipsum dolor sit amet: $p(x|y) = \frac{p(y|x)p(x)}{p(y)}$
This is inline `#!js var test=0;` code highlighting --> with some <--> text
### Inline Formula Example
Yet another test!
\ No newline at end of file
This is the y combinator $ Y = \lambda f.(\lambda x.f(x x)) (\lambda x.f (x x)) $.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment