layout | title | subtitle | description | toc |
---|---|---|---|---|
page |
Example Page |
Example Page Subtitle |
Example Page Description |
true |
The source code of our wiki is written in MarkDown
, like on Slack. You can see basic markdown highlighting.
Behind the scenes jekyll
renders the contents.
At the very top of every md file there should be a block like this:
---
layout: page # mandatory, use page always
title: Example Page # mandatory
subtitle: Example Page Subtitle # optional
description: Example Page Description # optional
toc: true # optional
---
There is code highlighting enabled. For that after the triple tick or tilde name the language (for example: ```c++ ... ``` for C++
; pandoc-like syntax will not work).
Some examples:
Bash
echo "Bash Higlighting"
cd love_larsoft
C++
const int rankOfThisWiki = 1;
const std::string call_for_wikitypists = "Please contribute to our wiki";
Python
import numpy as np
def neat_wiki_function(content)
LaTeX
\chapter{The SBND Experiment and the SBN Programme}
\begin{itemize}
\item List 1
\item List 2
\end{itemize}
For math, you can have: Inline math
Long math
Centered math
you can also have references, like equation \ref{eq:mc2}, ... but maybe not yet working:
Note that math will not render in GitHub preview.
Some text under top heading
Text in this section