Note
This repository is the source for docs.picpeak.app.
Anything that lands on main here is published to the public docs site.
This is the docs site for PicPeak — an open-source, self-hosted photo sharing platform for events. The site itself is a Next.js + Nextra static export that builds to plain HTML and ships to docs.picpeak.app.
For the PicPeak application's source code, see PicPeak/picpeak. This repo is content only — no application logic.
Requires Node.js 22+ and npm.
git clone https://github.com/PicPeak/docs.git picpeak-docs
cd picpeak-docs
npm install
npm run dev # http://localhost:3000 with live reloadBuild the static site the way docs.picpeak.app does:
npm run build # produces ./out/out/ is the static export — that's what the deploy hook publishes.
.
├── app/ # Next.js App Router — every page is MDX
│ ├── page.mdx # docs.picpeak.app homepage
│ ├── _meta.js # top-level nav order + labels
│ ├── getting-started/
│ ├── features/
│ ├── deployment/
│ ├── guides/
│ ├── api/
│ └── contributing/ # in-site contributing page (for PicPeak app contributors)
├── public/ # images, favicons, static assets
├── mdx-components.jsx # custom MDX component overrides
├── next.config.mjs # Nextra config (static export mode)
└── package.json
Each subdirectory has its own _meta.js controlling order + labels of pages within that section.
| To edit... | Open... |
|---|---|
| Homepage hero / quick links | app/page.mdx |
| Top-level nav order or labels | app/_meta.js |
| Section nav (e.g. order under Deployment) | app/<section>/_meta.js |
| A specific guide / reference page | app/<section>/<slug>/page.mdx |
| Add an image | drop in public/images/, reference as /images/foo.png |
See CONTRIBUTING.md for the full PR workflow, MDX style notes, and review process.
TL;DR: fork → branch from main → edit MDX → open PR against main. Lands live on docs.picpeak.app after merge.
- Documentation bugs / outdated info / typos — file here: issues on this repo
- Bugs in the PicPeak application itself — file on the main repo: PicPeak/picpeak issues
MIT — same as the parent PicPeak project.