Skip to content
bookhoardPublic

About

Documentation site for Bookhoard, a self-hosted EPUB library.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Bookhoarder

Bookhoarder Docs

Documentation site for Bookhoarder, a self-hosted EPUB library. Built with Nimbus.

Deploy Site App repo

Live at docs.bookhoarder.dev — covers Features, Deployment (Docker, Cloudflare, Kubernetes), Storage backends, and the HTTP API.

Develop

pnpm install
pnpm dev

Build

pnpm build   # static output to dist/
pnpm preview

A Makefile wraps these as make dev, make build, make preview, make typecheck, make lint, and make clean — see make help.

Deploy

Pushes to main build and deploy automatically to GitHub Pages via .github/workflows/deploy.yml. The site is served at https://docs.bookhoarder.dev, backed by GitHub Pages' default bookhoard.github.io host via a CNAME record and the public/CNAME file in this repo.

On first deploy, enable Pages for this repo under Settings → Pages → Source → GitHub Actions.

Contributing

This repo holds only the documentation — for the application itself, see bookhoard/bookhoarder. See AGENT.md for the site's file layout and authoring conventions (frontmatter shape, adding pages, running nimbus-docs check).

About

Documentation site for Bookhoard, a self-hosted EPUB library.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages