Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 1.45 KB

DEVELOPMENT.md

File metadata and controls

49 lines (36 loc) · 1.45 KB
Raw

Jak na vývoj

Instalace nástrojů

Budeme potřebovat:

  • git
  • python3 + pip (na Windows doporučuji z Win storu)
  • nodejs + npm (je součástí instalace)

Repo

Naklonujeme si repozitář:

git clone https://github.com/RoboticsBrno/<repo_name>.git
NEBO
git clone git@github.com:RoboticsBrno/<repo_name>.git

Konfigurace

Otevři projekt a v terminálu spusť:

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r requirements.txt
npm install

Práce s dokumentací

Lokální spuštění dokumentace:

source .venv/bin/activate
python3 -m mkdocs serve

Vychytávky

Pro více rojetých dokumentací je možné použít --dev-addr 127.0.0.1:8001 pro specifikaci adresy a portu.

Práce s obrázky

Obrázky přidávej do podsložek v docs podle adresy stránky, na které se mají zobrazit. Uvnitř této stránky vytvoř složku assets-large a vlož do ní obrázky v plné velikosti.

Plugin mkdocs-resize-images automaticky rozpozná změny v adresáři assets-large a při buildu zmenší obrázky do požadované velikosti a uloží je do složky assets. Složka assets-large se neukládá do gitu, protože by byla zbytečně velká. Velké fotky si necháme jen lokálně a po dokončení návodu je můžete smazat.

Podporovené soubory jsou .jpg, .jpeg, .png, .gif, .svg.