This Wiki works via GitHub services, so simply click here
- Then create or select any subpath from
_doc/
directory and name your file as you want with .md extension. - Just add the following header:
---
layout: doc
title: <Your title>
permalink: /doc/<path>/
---
- Where
<path>
should be to .md file without extension. For example, set/doc/My-Page/
if you will add the My Page.md in root _doc directory.
Now you're ready to create your awesome page below from this header. Use markdown syntax or see existing pages.
Markdown syntax
Highlighting
Use this (GitHub Flavored Markdown):
```lang your data ```
List
* Item 1
* Item 2
* Item 3
* Item4
Images
![alt](../../Resources/path)
With link:
[![alt](../../Resources/path)](link)
Templates
Fillme box
{% include elem/fillme %}
List of available pages from specific path
{% assign cprefix = "/PathToDoc/" %}
{% assign urlPrefix = {{site.docp | append: "/PathToDoc/"}} %}
{% include doc/List.html %}
To escape liquid tags
{% raw %}
.. data
{% endraw %}
for source code with highlighting:
{% raw %} ```lang source code ``` {% endraw %}
To display images with Lightbox
{% assign img = "image" %}{% assign attr = "width='380' height='260'" %}{% include elem/lightbox %}
Where:
- image - path to image file from
/doc/Resources/
. - width & height - size for preview.
Info box
{% assign infoData = "data with markdown syntax" %}
{% include elem/info %}
With custom color:
{% assign infoColor = "#CACA35" %}
{% assign infoData = "data with markdown syntax" %}
{% include elem/info %}
Glyphicons
{% assign icon = "type" %}{% include elem/gicon %}
or:
<span class="glyphicon type" aria-hidden="true"></span>
Where:
- type - e.g.:
glyphicon-flag
:
Old wiki
We used this before: