Návod k použití — Doxa (v26.06.04.beta)

Krátké shrnutí: Doxa je minimalistická, local‑first poznámková aplikace založená na otevřeném JSON formátu s podporou Markdown. Data zůstávají lokálně (localStorage nebo soubor) — aplikace nic sama neodesílá.

Rychlý start - pouze pro variantu spouštění aplikace u sebe lokalně

Pokud aplikaci spouštíš z webu https://doxa.lukan.cz/ pokračuj dalším bodem!

1. Stáhni/klonuj repozitář a přejdi do složky aplikace:

   cd doxa/web_app

2. Spusť jednoduchý lokální server (doporučeno):

   python3 -m http.server 8000

   a otevři v prohlížeči: http://localhost:8000
3. alternativně můžeš použít Node.js a pomocí npm install nainstaluj live-server a následně spusť pomocí příkazu: live-server ve složce aplikace.

Desktop aplikace

1. Desktop aplikace je dostupná pro Windows a Linux. Stačí si ji stáhnout z Codeberg a spustit.

2. Staženou aplikaci spustíš spustíš otevřením souboru windows - .exe nebo linux - .AppImage

3. Soubory aplikací najdeš ve složce:

Linux: ~/.config/doxa/

Nezapomeň si dělat pravidélné zálohy JSON (exportovat JSON)

Nezapomeň si pravidelně aktualizovat aplikaci, abys mohl mít nejnovější verzi.

POZOR: v desktop verzi se nachází chyba s přidáváním nových poznámek. Aby jste mohli přidat novou poznámku, musíte nejprve kliknout na jinou záložku v menu a poté zpět na záložku poznámek.

Desktop app: nevycházejí s pravidelností jako web app, z důvodu buildu a náročnosti na zdroje. Desktop app bude vydáván pouze po větších funkčních změnách.

---

Vytvoření nové poznámky

1. Klikni na tlačítko ➕ Nová poznámka a zadej název.
2. Položka se objeví v seznamu. Klikem načteš název a obsah do editoru nahoře.
3. Uprav obsah a klikni Uložit nyní.

Editace a mazání

• Inline: klikni na poznámku, uprav obsah a stiskni Uložit nyní.
• Modal: klikni na ikonu ✎ vedle položky pro pokročilou editaci v modal okně.
• Mazání: ikona 🗑 u položky — po potvrzení se poznámka smaže.

Přesouvání pořadí poznámek

• Použij šipky ↑ / ↓ u položek.
• Nebo přetahuj položky (drag & drop) na požadované místo — při přetažení se ukáže indikátor vložení.

Přepínání vzhledu

V horním menu najdeš tlačítko pro přepínání vzhledu. Aplikace podporuje tři režimy:

• Světlý — ikona: ☀️
• Tmavý — ikona: 🌙
• Respektovat systém — ikona: 🌓 — aplikace bude sledovat systémovou volbu (prefers-color-scheme) a automaticky se přepne, pokud se změní systémový motiv.

Kliknutím na tlačítko v menu cyklíš mezi režimy (Light → Dark → System). Vybraná volba se uloží do localStorage pod klíčem doxa_theme a přetrvá mezi stránkami a obnovami. Pokud chceš volbu resetovat, otevři konzoli prohlížeče a spusť: localStorage.removeItem('doxa_theme') nebo vymaž storage v nástrojích pro vývojáře.

Automatické ukládání

Aplikace nyní automaticky ukládá změny poznámek lokálně během psaní (autosave). V běžném prohlížeči se změny ukládají do localStorage (klíč doxa_notes_v1) bez nutnosti manuálního ukládání — data se uloží po krátké prodlevě. Pokud aplikaci spouštíš v Electron/Node režimu, změny se zapisují přímo do lokálního souboru.

Průběžně si úkládej i JSON soubor manuálně!!

Manuální uložení

Vedle editoru najdeš tlačítko Uložit nyní. I když autosave ukládá průběžně, tlačítko je užitečné v těchto případech:

• Okamžité uložení — provede persist bez čekání na autosave (užitečné před zavřením aplikace nebo pokud chcete rychlou jistotu, že jsou změny zapsány).
• Vizuální potvrzení — po uložení se zobrazí stav „Uloženo“, což dává uživateli okamžitou zpětnou vazbu.
• Bez stažení — tlačítko Uložit poznámku neprovádí stažení souboru; pokud chcete stáhnout JSON, použijte tlačítko Exportovat JSON.

Pro přenos dat mezi zařízeními použijte tlačítko Exportovat JSON (stáhne soubor doxa.json), nebo z konzole spusťte saveNotesToFile(true).

Import / Export

Pro import klikni Importovat JSON a vyber soubor. Podporované formáty:

• Objekt s polem notes: { "notes": [ ... ] }
• Přímo pole: [ { ... }, { ... } ]

Export je nyní dostupný přes tlačítko Exportovat JSON (vedle tlačítka Uložit). Aplikace zároveň provádí autosave lokálně — nic neztratíte, pokud zapomenete manuálně uložit. Chcete-li stáhnout JSON přes skript, můžete také spustit v konzoli saveNotesToFile(true).

Bezpečnost a zálohy

Výchozí režim je local‑first: data zůstávají ve tvém prohlížeči (localStorage) nebo lokálním souboru, aplikace je sama neodesílá.

---

Editor používá Markdown

Editor pracuje s Markdown syntaxí. Všechny úpravy se ukládají jako Markdown (čistý text) — náhled ukazuje vykreslené HTML. Níže základní příklady (vložte je přímo do editoru nebo použijte tlačítka v toolbaru):

Tučné: **tučný text**
Kurzíva: *kurzíva*
Přeškrtnutí: ~~přeškrtnuté~~
Inline kód: `kód`
Kódový blok:
```
console.log('hello')
```
Nadpisy:
# Nadpis H1
## Nadpis H2
### Nadpis H3
Seznam (odrážky):
- položka 1
- položka 2
Číslovaný seznam:
1. první
2. druhý
Citace:
> Toto je citace
Tabulka:
| Sloupec 1 | Sloupec 2 |
| --- | --- |
| bunka 1 | bunka 2 |
| bunka 3 | bunka 4 |
Obrázek (referenční URL):
![alt text](https://example.com/obrazek.png)
Odkaz:
[text](https://example.com)
Úkoly (task list):
- [ ] nedokončeno
- [x] hotovo

Důležité tipy:

• Kliknutím na tlačítka v toolbaru vložíte potřebné Markdown tokeny automaticky.
• Stiskněte Ctrl/Cmd+B pro tučné, Ctrl/Cmd+I pro kurzívu a Ctrl/Cmd+` pro inline kód.
• Tlačítko Náhled přepne vykreslení Markdownu; používejte jej k ověření výsledku.
• Tlačítko Live zapne průběžný živý náhled — preview se automaticky aktualizuje během psaní a zobrazí se, pokud nebyl ručně skrytý.
• Tlačítko Tabulka (▦) vloží šablonu tabulky a během vložení vás vyzve na počet sloupců a řádků.
• Obrázky vkládejte jako URL — aplikace obrázky nesynchronizuje ani nahrává.
• Markdown je přenosný: poznámky zůstávají čitelné i bez aplikace (export/import).

Časté problémy

• Při otevírání přes file:// může fetch statického JSONu selhávat — použij lokální server nebo Electron.
• Přenos dat mezi zařízeními? Stáhni JSON a importuj ho na druhém zařízení.

Zpět na hlavní stránku