nessie-docs

Official documentation for Nessie Graph Explorer.

A fully static HTML/CSS/JS documentation site — no build step, no framework, no dependencies. Deploy anywhere: Netlify, GitHub Pages, Vercel, or just open index.html in a browser.

Contents

Page	Description
index.html	Overview and ecosystem map
quickstart.html	Install, scaffold, start, load first graph
architecture.html	System layers, plugin system, UML diagrams, request lifecycle
actions.html	Complete action reference with payloads and return types
plugins.html	All official plugins with descriptions and setup fields
create-visualizer.html	Step-by-step guide to building a custom visualizer plugin
create-datasource.html	Step-by-step guide to building a custom datasource plugin
cli.html	Project CLI (nessie commands) and in-browser console command reference

Design

The docs follow the Nessie Graph Explorer design system exactly — dark theme, JetBrains Mono + Syne typography, #0c0d10 background, #00d9ff cyan accent. The scanline overlay and scrollbar styling match the application itself.

Local Development

# No build needed — open directly
open index.html

# Or serve with any static file server
npx serve .
python3 -m http.server 3000

Deploying to Netlify

1. Push this directory to a GitHub repo
2. Create a new Netlify site from Git
3. Set Publish directory to / (or the folder containing index.html)
4. Deploy

No build command needed.

Deploying to GitHub Pages

git init
git add .
git commit -m "Initial docs"
git branch -M main
git remote add origin https://github.com/Nessie-org/nessie-docs.git
git push -u origin main

Then enable GitHub Pages in the repo settings, pointing at the main branch root.

License

MIT © Nessie-org