Feature overview

NovaDocs is a full documentation CMS: write in admin, publish a branded public site, and automate with API, webhooks, and optional add-ons.

Hosting & ownership

Self-hosted on Docker, VPS, or Vercel
Postgres, MySQL, or SQLite (SQLite for local only)
Your data stays in your database

Documentation sites

Multi-project workspaces
Versions and languages
Nested sidebar, TOC, breadcrumbs, prev/next
Dark mode and minimal scrollbars
Custom domains
Announcement banners
Optional members-only docs

Writing

Block editor with slash commands
Drafts, schedule, publish
Revision history
Images and file attachments
Syntax-highlighted code (filenames, copy button, package-manager tabs)
File / folder trees (IDE-style)
Content tabs, numbered steps, callouts, Mermaid diagrams, tables
Accordions, card grids, comparison tables, video embeds
Click-to-zoom images

Appearance

Per-project theme editor (Admin → Projects → Customize)
Presets plus custom colors for light and dark mode
Corners, depth, link style, and font controls
Three sidebar styles, with a live preview

Migration

GitBook import
GitHub sync
Markdown import / export
JSON export

Automation

REST API with personal API keys
Webhooks (including Discord channel embeds)
Discord companion bot (separate add-on) for /docs search in your support server
Config playground (separate add-on) for interactive config files and commands
Broken link scanner
Redirects

Team

Platform roles and project members
API keys per user
Profile settings

Live examples

The blocks below are real NovaDocs content — the same ones readers see on your public docs.

Config builder, config checker, and command builder live on the Config playground add-on page. They are not part of the base product.

Callouts

tip

Use callouts for tips, warnings, and important notes. In Markdown: > [!TIP], > [!WARNING], > [!DANGER], or > [!INFO].

warning

Always back up before a major upgrade. Export JSON from Admin → Import / Export if you need a full project dump.

Callout colors come from your project theme, so they always match your brand.

Card grid

Point readers at the pages that matter most. Cards can link anywhere and take an optional icon:

Install with Docker

One command on any VPS.

Reader features

Search, themes, bookmarks, and feedback.

REST API

Automate content with personal API keys.

Discord bot

Answer support questions from your docs.

Config playground

Readers build and check config files on the page.

Accordion

Perfect for FAQs — panels stay collapsed until a reader opens them:

Postgres is recommended for production. SQLite works for local development — set DATABASE_URL in .env.

Comparison table

Feature matrices with checkmarks, dashes, or custom text per cell:

	SQLite	Postgres
Setup effort	None	Container or managed host
Good for local development
Recommended for production
Concurrent writers
Full-text search	Basic	Advanced

Video

Paste a YouTube, Vimeo, or MP4 URL and NovaDocs picks the right player:

Swap this for your own product walkthrough.

File & folder tree

Show project layout the way an IDE would — nest with indentation, end folders with /, and mute ignored files with *:

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

In Markdown, use a fenced block with language files (also nova-tree or file-tree).

Code with a filename

lib/config.ts

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

Tabbed commands

Great for install snippets — readers pick their package manager:

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

Add the tabs meta (or use language package-install) and separate panes with === label === lines.

Numbered steps

Create a project

Open Admin → Projects and create a docs project (name, slug, accent color).

Write an article

Use the block editor or paste Markdown. Slash commands insert tabs, steps, and file attachments.

Publish

Set status to Published. Readers find it under /{project}/docs/{version}/{lang}/….

Content tabs

Best for a VPS. See Install with Docker.

Images

Any image in an article becomes click-to-zoom — readers get a full-screen view, and Esc closes it. Nothing to configure.

Theming

Every block above takes its colors, corners, and elevation from the project theme. Open Admin → Projects → Customize to pick a preset or set your own colors for light and dark mode, then watch the live preview update as you go.

Where to go next

Reader features — search, theme, feedback, and more
Discord companion bot — optional add-on for support servers
Config playground — optional add-on for interactive configs
Setting up webhooks — Discord embeds and custom endpoints