mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
165 lines
10 KiB
HTML
165 lines
10 KiB
HTML
<!doctype html>
|
||
<html lang="cs">
|
||
<head>
|
||
<meta charset="UTF-8" />
|
||
<title>Návod — Doxa</title>
|
||
<link rel="stylesheet" href="assets/style/style.css" />
|
||
<link rel="shortcut icon" href="assets/img/brain-solid-full.svg" />
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/default.min.css" />
|
||
<script src="https://cdn.jsdelivr.net/npm/markdown-it/dist/markdown-it.min.js"></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/dompurify/dist/purify.min.js"></script>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
||
</head>
|
||
<body>
|
||
<div class="container">
|
||
<nav class="top-nav">
|
||
<a href="index.html">Domů</a>
|
||
<a href="navod.html">Návod</a>
|
||
<a href="privacy.html">Ochrana soukromí</a>
|
||
<a href="about.html">O projektu</a>
|
||
<button id="themeToggle" class="theme-toggle" aria-label="Přepnout motiv">🌙</button>
|
||
</nav>
|
||
|
||
<h1>Návod k použití — Doxa (v26.6.04.beta)</h1>
|
||
|
||
<p>Krátké shrnutí: Doxa je minimalistická, <strong>local‑first</strong> 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á.</p>
|
||
|
||
<h2>Rychlý start - pouze pro variantu spouštění aplikace u sebe lokalně</h2>
|
||
<p>Pokud aplikaci spouštíš z webu <strong>https://doxa.lukan.cz/</strong> pokračuj dalším bodem!</p>
|
||
<ol>
|
||
<li>Stáhni/klonuj repozitář a přejdi do složky aplikace:
|
||
<pre><strong>cd doxa/web_app</strong></pre>
|
||
</li>
|
||
<li>Spusť jednoduchý lokální server (doporučeno):
|
||
<pre><strong>python3 -m http.server 8000</strong></pre>
|
||
a otevři v prohlížeči: <code><strong>http://localhost:8000</strong></code>
|
||
</li>
|
||
<li>alternativně můžeš použít Node.js a pomocí npm install nainstaluj live-server a následně spusť pomocí příkazu: <code><strong>live-server</strong></code> ve složce aplikace.
|
||
</li>
|
||
</ol>
|
||
|
||
<h2>Desktová aplikace</h2>
|
||
<p>1. Desktová aplikace je dostupná pro Windows a Linux. Stačí si ji stáhnout z <a href="https://codeberg.org/Kankys/doxa/releases" target="_blank">Codeberg</a> a spustit.</p>
|
||
<p>2. Staženou aplikaci spustíš spustíš otevřením souboru linux - .AppImage</p>
|
||
<p>3. Soubory aplikací najdeš ve složce:</p>
|
||
|
||
<p><strong>Linux:</strong> <code>~/.config/doxa/</code></p>
|
||
<p><strong>Nezapomeň si dělat pravidélné zálohy JSON (exportovat JSON)</strong></p>
|
||
<p><strong>Nezapomeň si pravidelně aktualizovat aplikaci, abys mohl mít nejnovější verzi.</strong></p>
|
||
<p><strong>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.</strong></p>
|
||
|
||
<hr>
|
||
<h2>Vytvoření nové poznámky</h2>
|
||
<ol>
|
||
<li>Klikni na tlačítko <strong>➕ Nová poznámka</strong> a zadej název.</li>
|
||
<li>Položka se objeví v seznamu. Klikem načteš název a obsah do editoru nahoře.</li>
|
||
<li>Uprav obsah a klikni <strong>Uložit nyní</strong>.</li>
|
||
</ol>
|
||
|
||
<h2>Editace a mazání</h2>
|
||
<ul>
|
||
<li>Inline: klikni na poznámku, uprav obsah a stiskni <strong>Uložit nyní</strong>.</li>
|
||
<li>Modal: klikni na ikonu ✎ vedle položky pro pokročilou editaci v modal okně.</li>
|
||
<li>Mazání: ikona 🗑 u položky — po potvrzení se poznámka smaže.</li>
|
||
</ul>
|
||
|
||
|
||
<h2>Přesouvání pořadí poznámek</h2>
|
||
<ul>
|
||
<li>Použij šipky ↑ / ↓ u položek.</li>
|
||
<li>Nebo přetahuj položky (drag & drop) na požadované místo — při přetažení se ukáže indikátor vložení.</li>
|
||
</ul>
|
||
|
||
<h2>Přepínání vzhledu</h2>
|
||
<p>V horním menu najdeš tlačítko pro přepínání vzhledu. Aplikace podporuje tři režimy:
|
||
<ul>
|
||
<li><strong>Světlý</strong> — ikona: ☀️</li>
|
||
<li><strong>Tmavý</strong> — ikona: 🌙</li>
|
||
<li><strong>Respektovat systém</strong> — ikona: 🌓 — aplikace bude sledovat systémovou volbu (prefers-color-scheme) a automaticky se přepne, pokud se změní systémový motiv.</li>
|
||
</ul>
|
||
Kliknutím na tlačítko v menu cyklíš mezi režimy (Light → Dark → System). Vybraná volba se uloží do <code>localStorage</code> pod klíčem <code>doxa_theme</code> a přetrvá mezi stránkami a obnovami. Pokud chceš volbu resetovat, otevři konzoli prohlížeče a spusť: <code>localStorage.removeItem('doxa_theme')</code> nebo vymaž storage v nástrojích pro vývojáře.</p>
|
||
|
||
<h2>Automatické ukládání</h2>
|
||
<p>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 <code>localStorage</code> (klíč <code>doxa_notes_v1</code>) 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.</p>
|
||
<p style="color: red;"><strong>Průběžně si úkládej i JSON soubor manuálně!!</strong></p>
|
||
<h2>Manuální uložení</h2>
|
||
<p>Vedle editoru najdeš tlačítko <strong>Uložit nyní</strong>. I když autosave ukládá průběžně, tlačítko je užitečné v těchto případech:</p>
|
||
<ul>
|
||
<li><strong>Okamžité uložení</strong> — 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).</li>
|
||
<li><strong>Vizuální potvrzení</strong> — po uložení se zobrazí stav „Uloženo“, což dává uživateli okamžitou zpětnou vazbu.</li>
|
||
<li><strong>Bez stažení</strong> — tlačítko <strong>Uložit poznámku</strong> neprovádí stažení souboru; pokud chcete stáhnout JSON, použijte tlačítko <strong>Exportovat JSON</strong>.</li>
|
||
</ul>
|
||
|
||
<p>Pro přenos dat mezi zařízeními použijte tlačítko <strong>Exportovat JSON</strong> (stáhne soubor <code>doxa.json</code>), nebo z konzole spusťte <code>saveNotesToFile(true)</code>.</p>
|
||
|
||
<h2>Import / Export</h2>
|
||
<p>Pro import klikni <strong>Importovat JSON</strong> a vyber soubor. Podporované formáty:
|
||
<ul>
|
||
<li>Objekt s polem <code>notes</code>: <code>{ "notes": [ ... ] }</code></li>
|
||
<li>Přímo pole: <code>[ { ... }, { ... } ]</code></li>
|
||
</ul>
|
||
Export je nyní dostupný přes tlačítko <strong>Exportovat JSON</strong> (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 <code>saveNotesToFile(true)</code>.</p>
|
||
|
||
<h2>Bezpečnost a zálohy</h2>
|
||
<p>Výchozí režim je <strong>local‑first</strong>: data zůstávají ve tvém prohlížeči (localStorage) nebo lokálním souboru, aplikace je sama neodesílá.</p>
|
||
<hr>
|
||
<h2>Editor používá Markdown</h2>
|
||
<p>Editor pracuje s <strong>Markdown</strong> 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):</p>
|
||
|
||
<pre><code>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):
|
||

|
||
Odkaz:
|
||
[text](https://example.com)
|
||
Úkoly (task list):
|
||
- [ ] nedokončeno
|
||
- [x] hotovo
|
||
</code></pre>
|
||
|
||
<p>Důležité tipy:</p>
|
||
<ul>
|
||
<li>Kliknutím na tlačítka v toolbaru vložíte potřebné Markdown tokeny automaticky.</li>
|
||
<li>Stiskněte <kbd>Ctrl/Cmd+B</kbd> pro tučné, <kbd>Ctrl/Cmd+I</kbd> pro kurzívu a <kbd>Ctrl/Cmd+`</kbd> pro inline kód.</li>
|
||
<li>Tlačítko <strong>Náhled</strong> přepne vykreslení Markdownu; používejte jej k ověření výsledku.</li>
|
||
<li>Tlačítko <strong>Live</strong> zapne průběžný živý náhled — preview se automaticky aktualizuje během psaní a zobrazí se, pokud nebyl ručně skrytý.</li>
|
||
<li>Tlačítko <strong>Tabulka</strong> (▦) vloží šablonu tabulky a během vložení vás vyzve na počet sloupců a řádků.</li>
|
||
<li>Obrázky vkládejte jako URL — aplikace obrázky nesynchronizuje ani nahrává.</li>
|
||
<li>Markdown je přenosný: poznámky zůstávají čitelné i bez aplikace (export/import).</li>
|
||
</ul>
|
||
<h2>Časté problémy</h2>
|
||
<ul>
|
||
<li>Při otevírání přes <code>file://</code> může fetch statického JSONu selhávat — použij lokální server nebo Electron.</li>
|
||
<li>Přenos dat mezi zařízeními? Stáhni JSON a importuj ho na druhém zařízení.</li>
|
||
</ul>
|
||
|
||
<p><a href="index.html">Zpět na hlavní stránku</a></p>
|
||
</div>
|
||
<footer><p class="copyright">©2026 Doxa Notes - <a href="https://lukaskanka.cz/" target="_blank">Kankys</a></p></a</footer>
|
||
<script src="assets/js/script.js"></script>
|
||
</body>
|
||
</html>
|