Nanome Docs

Documentation site for Nanome software, hosted at docs.nanome.ai. Built with VitePress.

Prerequisites

• Node.js >= 20

Development

npm install
npm run dev

Build

npm run docs:build
npm run docs:preview  # preview the built site locally

Images

Place original images in docs/public/assets/original/, then run:

npm run docs:compress

This generates optimized versions in docs/public/assets/compressed/. Do not manually add files to the compressed folder — it is entirely managed by the compress script.

Project Structure

docs/
├── .vitepress/       # VitePress config and theme
├── nanome1x/         # Nanome 1.24 (1st Gen) docs
├── nanome_v2/        # Nanome v2 (2nd Gen) docs
├── mara/             # MARA docs
├── home.nanome.ai/   # Account management docs
├── help/             # Troubleshooting, hardware, FAQ
└── index.md          # Landing page