Documentation project

The goal of this documentation is to stop stack overflow syndrom (going to same page every time I search for something, and re-reading full page) and capitalize on all stuff I learn here instead. This documentation is available at: https://wiki.autopdutop.fr

Usage

Official installation Guide

Prerequisites

• Python installed
• Pip installed

Get project

git clone https://github.com/arthurmauvezin/wiki.git

Install Mkdocs and themes

pip install --user -r requirements.txt

Start server

python -m mkdocs serve

Build site

python -m mkdocs build

Useful Aliases (add to .bashrc or .zshrc)

#### WIKI ####
alias wiki-start='cd ~/wiki/ && nohup mkdocs serve &>/dev/null &'
alias wiki-stop='kill -9 $(pgrep -a mkdocs | cut -d '"'"' '"'"' -f 1)'
alias wiki-reload='wiki-stop && wiki-start'
alias wiki='if ! [[ $(pgrep -a mkdocs) ]]; then wiki-start; fi && google-chrome-stable --app=http://localhost:8000'

Help writing documentation

• Markdown CheatSheet
• Extension: Note and warning block

!!! note
    Example of note

!!! failure
    Example of failure