Przegląd funkcji

NovaDocs to pełny CMS dokumentacji: piszesz w adminie, publikujesz brandowaną stronę publiczną i automatyzujesz przez API, webhooki oraz opcjonalne dodatki.

Hosting i własność danych

Self-hosted na Dockerze, VPS lub Vercel
Postgres, MySQL lub SQLite (SQLite tylko lokalnie)
Dane zostają w Twojej bazie

Strony dokumentacji

Wiele projektów w jednym workspace
Wersje i języki
Zagnieżdżony sidebar, TOC, breadcrumbs, prev/next
Tryb ciemny i minimalistyczne paski przewijania
Własne domeny
Banery ogłoszeń
Opcjonalnie docs tylko dla członków

Pisanie

Edytor blokowy ze slash commands
Drafty, harmonogram, publikacja
Historia rewizji
Obrazy i załączniki
Podświetlany kod (nazwy plików, kopiowanie, zakładki menedżerów pakietów)
Drzewa plików / folderów (jak w IDE)
Zakładki treści, numerowane kroki, callouty, diagramy Mermaid, tabele
Akordeony, siatki kart, tabele porównawcze, filmy
Obrazy powiększane kliknięciem

Wygląd

Edytor motywu per projekt (Admin → Projekty → Personalizuj)
Gotowe motywy oraz własne kolory dla trybu jasnego i ciemnego
Ustawienia zaokrągleń, cieni, stylu linków i czcionki
Trzy style paska bocznego, z podglądem na żywo

Migracja

Import z GitBook
Sync z GitHub
Import / eksport Markdown
Eksport JSON

Automatyzacja

REST API z kluczami API
Webhooki (w tym embedy Discord)
Bot Discord (osobny dodatek) — wyszukiwanie /docs na serwerze support
Config playground (osobny dodatek) — interaktywne pliki config i komendy
Skaner martwych linków
Przekierowania

Zespół

Role platformy i członków projektu
Klucze API na użytkownika
Ustawienia profilu

Żywe przykłady

Poniższe bloki to prawdziwa treść NovaDocs — dokładnie tak widzą ją czytelnicy.

Kreator configa, sprawdzanie configa i kreator komend są na stronie dodatku Config playground. Nie wchodzą w skład produktu bazowego.

Callouty

tip

Callouty służą do tipów, ostrzeżeń i ważnych notatek. W Markdown: > [!TIP], > [!WARNING], > [!DANGER] lub > [!INFO].

warning

Zawsze zrób backup przed większą aktualizacją. Eksport JSON znajdziesz w Admin → Import / Export.

Kolory calloutów pochodzą z motywu projektu, więc zawsze pasują do Twojej marki.

Siatka kart

Pokaż czytelnikom najważniejsze strony. Karty mogą prowadzić dokądkolwiek i mają opcjonalną ikonę:

Instalacja z Dockerem

Jedna komenda na dowolnym VPS.

Funkcje dla czytelnika

Wyszukiwanie, motywy, zakładki i opinie.

REST API

Automatyzuj treść kluczami API.

Bot Discord

Odpowiadaj na pytania supportu z dokumentacji.

Config playground

Czytelnicy budują i sprawdzają pliki config na stronie.

Akordeon

Idealny do FAQ — panele są zwinięte, dopóki czytelnik ich nie otworzy:

Na produkcji zalecamy Postgresa. SQLite wystarczy lokalnie — ustaw DATABASE_URL w .env.

Tabela porównawcza

Macierze funkcji z ptaszkami, kreskami albo własnym tekstem w komórce:

	SQLite	Postgres
Trudność konfiguracji	Brak	Kontener lub hosting
Dobre lokalnie
Zalecane na produkcji
Równoległe zapisy
Wyszukiwanie pełnotekstowe	Podstawowe	Zaawansowane

Film

Wklej link z YouTube, Vimeo lub plik MP4 — NovaDocs wybierze odpowiedni odtwarzacz:

Podmień na własny przewodnik po produkcie.

Drzewo plików i folderów

Pokaż strukturę projektu jak w IDE — wcięcia, foldery kończą się na /, wyciszone pliki oznacz *:

layout.tsx

page.tsx

docs-code-block.tsx

docs-file-tree.tsx

schema.prisma

seed-docs.ts

README.md

package.json

docker-compose.yml

.env.example

W Markdown użyj bloku z językiem files (albo nova-tree / file-tree).

Kod z nazwą pliku

lib/config.ts

export const siteName = "NovaDocs";
export const defaultAccent = "#22c55e";

Zakładki komend

Idealne do snippetów instalacji — czytelnik wybiera menedżer pakietów:

npm install
npm run db:push
npm run db:seed
npm run build

Dodaj meta tabs (lub język package-install) i rozdziel panele liniami === etykieta ===.

Numerowane kroki

Utwórz projekt

Otwórz Admin → Projekty i stwórz projekt docs (nazwa, slug, kolor).

Napisz artykuł

Użyj edytora blokowego albo wklej Markdown. Slash commands wstawiają zakładki, kroki i załączniki.

Opublikuj

Ustaw status Published. Czytelnicy znajdą treść pod /{project}/docs/{version}/{lang}/….

Zakładki treści

Najlepiej na VPS. Zobacz Instalacja z Dockerem.

Obrazy

Każdy obraz w artykule powiększa się po kliknięciu — czytelnik dostaje widok pełnoekranowy, a Esc go zamyka. Nic nie trzeba konfigurować.

Motyw

Wszystkie bloki powyżej biorą kolory, zaokrąglenia i cienie z motywu projektu. Wejdź w Admin → Projekty → Personalizuj, wybierz gotowy motyw albo ustaw własne kolory dla trybu jasnego i ciemnego — podgląd aktualizuje się na żywo.

Co dalej

Funkcje dla czytelników — wyszukiwanie, motyw, feedback i więcej
Bot Discord — opcjonalny dodatek na serwery support
Config playground — opcjonalny dodatek do interaktywnych configów
Konfiguracja webhooków — embedy Discord i własne endpointy