{"id":47046971,"url":"https://github.com/joggrdocs/zpress","last_synced_at":"2026-04-10T22:01:46.640Z","repository":{"id":343814186,"uuid":"1169006359","full_name":"joggrdocs/zpress","owner":"joggrdocs","description":"Zero-effort, turnkey documentation sites for monorepos — just point it at your existing docs.","archived":false,"fork":false,"pushed_at":"2026-04-01T01:08:01.000Z","size":3793,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-03T00:38:52.609Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://zpress.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joggrdocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-28T03:45:13.000Z","updated_at":"2026-03-25T07:00:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/joggrdocs/zpress","commit_stats":null,"previous_names":["joggrdocs/zpress"],"tags_count":87,"template":false,"template_full_name":null,"purl":"pkg:github/joggrdocs/zpress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fzpress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fzpress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fzpress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fzpress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joggrdocs","download_url":"https://codeload.github.com/joggrdocs/zpress/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joggrdocs%2Fzpress/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31569400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-12T02:00:39.088Z","updated_at":"2026-04-08T19:01:01.234Z","avatar_url":"https://github.com/joggrdocs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"assets/banner.svg\" alt=\"zpress\" width=\"90%\" /\u003e\n  \u003cp\u003e\u003cstrong\u003eZero-effort, turnkey documentation sites for monorepos — just point it at your existing docs.\u003c/strong\u003e\u003c/p\u003e\n\n\u003ca href=\"https://github.com/joggrdocs/zpress/actions/workflows/ci.yml\"\u003e\u003cimg src=\"https://github.com/joggrdocs/zpress/actions/workflows/ci.yml/badge.svg?branch=main\" alt=\"CI\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/@zpress/kit\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@zpress/kit\" alt=\"npm version\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/joggrdocs/zpress/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/joggrdocs/zpress\" alt=\"License\" /\u003e\u003c/a\u003e\n\n\u003c/div\u003e\n\n## Features\n\n- **Your docs, your structure** — Conforms to your repo, not the other way around.\n- **Great defaults** — Sidebars, nav, landing pages, and icons from one config.\n- **Beautiful themes out of the box** — Dark mode, generated banners, and polished defaults.\n- **Monorepo-first** — Built for internal docs with first-class workspace support.\n\n## Install\n\n```bash\nnpm install @zpress/kit\n```\n\n## Usage\n\n### Define your docs\n\n```ts\n// zpress.config.ts\nimport { defineConfig } from '@zpress/kit'\n\nexport default defineConfig({\n  title: 'my-project',\n  description: 'Internal developer docs',\n  sections: [\n    {\n      text: 'Getting Started',\n      link: '/getting-started',\n      from: 'docs/getting-started.md',\n      icon: 'pixelarticons:speed-fast',\n    },\n    {\n      text: 'Guides',\n      prefix: '/guides',\n      icon: 'pixelarticons:book-open',\n      from: 'docs/guides/*.md',\n      textFrom: 'heading',\n      sort: 'alpha',\n    },\n  ],\n  nav: 'auto',\n})\n```\n\n### Run it\n\n```bash\nnpx zpress dev       # start dev server with hot reload\nnpx zpress build     # build for production\nnpx zpress serve     # preview production build\n```\n\n## Why `@zpress/kit` and not `zpress`?\n\nThe 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 :)\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoggrdocs%2Fzpress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoggrdocs%2Fzpress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoggrdocs%2Fzpress/lists"}