Markdown Syntax
We use GitHub Flavored Markdown (GFM) for writing documents. You can find a guide on how to write GFM here.
Additionally, we use the following syntax for writing documents:
Automatic Lead Text
The first paragraph of a document will be used as the lead text.
To avoid this behavior, you can insert an HTML comment (e.g. <!-- no-lead -->) or
a horizontal rule (---) before the first paragraph.
Bootstrap Icons
Use :bi-icon-name: to insert a Bootstrap icon. For example, :bi-book: will become .
Tabbed Code Blocks
Inspired by syntax of readme.com, you can create code blocks with the following syntax:
```javascript JavaScript
function hello() {
console.log('Hello, World!');
}
hello();
```
```python Python
def hello():
print('Hello, World!')
hello()
```
...To get tabbed code blocks like this:
function hello() {
console.log('Hello, World!');
}
hello();def hello():
print('Hello, World!')
hello()echo "Hello, World!"fn main() {
println!("Hello, World!");
}#include <stdio.h>
int main() {
printf("Hello, World!\n");
return 0;
}using System;
class Program
{
static void Main()
{
Console.WriteLine("Hello, World!");
}
}public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}