https://github.com/joggrdocs/zpress
Zero-effort, turnkey documentation sites for monorepos — just point it at your existing docs.
https://github.com/joggrdocs/zpress
Last synced: 3 months ago
JSON representation
Zero-effort, turnkey documentation sites for monorepos — just point it at your existing docs.
- Host: GitHub
- URL: https://github.com/joggrdocs/zpress
- Owner: joggrdocs
- License: mit
- Created: 2026-02-28T03:45:13.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-01T01:08:01.000Z (3 months ago)
- Last Synced: 2026-04-03T00:38:52.609Z (3 months ago)
- Language: TypeScript
- Homepage: https://zpress.dev
- Size: 3.62 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
Zero-effort, turnkey documentation sites for monorepos — just point it at your existing docs.
## Features
- **Your docs, your structure** — Conforms to your repo, not the other way around.
- **Great defaults** — Sidebars, nav, landing pages, and icons from one config.
- **Beautiful themes out of the box** — Dark mode, generated banners, and polished defaults.
- **Monorepo-first** — Built for internal docs with first-class workspace support.
## Install
```bash
npm install @zpress/kit
```
## Usage
### Define your docs
```ts
// zpress.config.ts
import { defineConfig } from '@zpress/kit'
export default defineConfig({
title: 'my-project',
description: 'Internal developer docs',
sections: [
{
text: 'Getting Started',
link: '/getting-started',
from: 'docs/getting-started.md',
icon: 'pixelarticons:speed-fast',
},
{
text: 'Guides',
prefix: '/guides',
icon: 'pixelarticons:book-open',
from: 'docs/guides/*.md',
textFrom: 'heading',
sort: 'alpha',
},
],
nav: 'auto',
})
```
### Run it
```bash
npx zpress dev # start dev server with hot reload
npx zpress build # build for production
npx zpress serve # preview production build
```
## Why `@zpress/kit` and not `zpress`?
The package is published as `@zpress/kit` because npm's moniker rules are overly aggressive and ban names that are similar in any way to existing packages. We will fix once we get npm to allow us to push to that namespace. If you work at `npm` please feel free to help out :)
## License
[MIT](LICENSE)