Contribute¶

How to make a document¶

Metadata¶

start each page with:

---
title: Name Of The Page
description: Description
tags:
    - topic
---

you can also add disquas: to turn off the comments section for a specific page

Abbreviations¶

add { ! docs/abbreviations.txt!} (without spaces near the "!") at the end of each page to use all of the available abbreviations.

Links¶

wrap each link like the following: [Link text](https://www.website.com){target=_blank rel=noopener}
add {target=_blank rel=noopener} at the end of each link to make it open in a new tab

Images¶

To add a picture, use the following syntax ![!Short Description](../assets/images/picName.jpg){.center .large}
You can add {.center} tag to make to picture centerly alligned insted of LTR
you can add sizes tage as well:
{.tiny} (35px)
{.xsmall} (80px)
{.small} (150px)
{.medium} (210px)
{.large} (300px)
{.xlarge} (450px)
{.big} (600px)

Cheat sheets¶

Markdown Guide
Github Markdown
Material for MkDocs
Yakworks cheat sheet for MkDocs Material
3OS Markdown CheatSheet For MkDocs

How to reach me¶

You can reach me at my E-mail
Or use one of the links at the bottom of the page to reach me on Telegram