53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
# RustPad 0.6.0
|
|
|
|
Współdzielony edytor Markdown z dwoma niezależnymi trybami:
|
|
|
|
- szybka notatka pod `/p/<slug>`,
|
|
- workspace z wieloma notatkami pod `/w/<slug>`.
|
|
|
|
Oba tryby obsługują opcjonalne hasła, edycję na żywo, SQLite, historię zmian, podgląd Markdown i stan widoku zapisany w URL.
|
|
|
|
## Uruchomienie lokalne
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
cargo run
|
|
```
|
|
|
|
Otwórz `http://127.0.0.1:3000`.
|
|
|
|
## Docker
|
|
|
|
```bash
|
|
cp .env.docker.example .env
|
|
docker compose up --build
|
|
```
|
|
|
|
Baza znajduje się w wolumenie `rustpad_data`.
|
|
|
|
## Adresy
|
|
|
|
```text
|
|
/p/notatka?view=split&mode=markdown
|
|
/w/workspace
|
|
/w/workspace/n/notatka?view=split&mode=markdown
|
|
```
|
|
|
|
## Frontend
|
|
|
|
- `home.js` — tworzenie szybkiej notatki i workspace,
|
|
- `pad.js` — samodzielna notatka,
|
|
- `workspace.js` — lista i tworzenie notatek w workspace,
|
|
- `note.js` — notatka należąca do workspace,
|
|
- `url-state.js` — stan widoku w URL,
|
|
- `clipboard.js` — kopiowanie pełnego adresu,
|
|
- `socket.js` — połączenia WebSocket,
|
|
- `markdown.js` — renderowanie Markdown,
|
|
- `editor-format.js` — formatowanie tekstu,
|
|
- `api.js` — komunikacja HTTP,
|
|
- `session.js` — hasła workspace w `sessionStorage`.
|
|
|
|
## Dane istniejące
|
|
|
|
Tabele `pads` i `revisions` pozostają aktywne. Workspace są dodatkiem, nie zamiennikiem zwykłych notatek. Przed aktualizacją wykonaj kopię `rustpad.db`.
|