Doccupine watches a public directory in your project root (the same folder where you execute npx doccupine) and copies its contents into the generated Next.js public folder. Use it to serve static files such as favicons, Open Graph preview images, custom fonts, or any other media your documentation needs.
Create a public folder at your project root. Any file you place inside is automatically synced to the generated site and served from the root URL path.
my-docs/
├── public/
│ ├── favicon.ico
│ ├── og-image.png
│ ├── logo.svg
│ └── fonts/
│ └── custom-font.woff2
├── docs/
│ └── index.mdx
├── config.json
└── theme.jsonFiles in the public directory are available at the root of your deployed domain. The path inside public maps directly to the URL path.
| File | URL |
|---|---|
public/favicon.ico | https://your-domain.com/favicon.ico |
public/og-image.png | https://your-domain.com/og-image.png |
public/logo.svg | https://your-domain.com/logo.svg |
public/fonts/custom-font.woff2 | https://your-domain.com/fonts/custom-font.woff2 |
Drop a favicon.ico into the public folder. Browsers pick it up automatically from the root path.
public/favicon.ico → https://your-domain.com/favicon.icoAdd an image for link previews on social media. Reference it in your config.json so Doccupine sets the correct meta tags.
public/og-image.png → https://your-domain.com/og-image.pngPlace font files in public and reference them from your fonts.json. See the Fonts page for full configuration details.
public/fonts/custom-font.woff2 → https://your-domain.com/fonts/custom-font.woff2Any image or file you want to reference in your MDX pages can live in public. Use a root-relative path in your content:
Doccupine watches the public directory for changes while running. When you add, update, or remove a file, the generated site is updated automatically.
public keeps paths short and simple.public/fonts, public/images, or public/icons.og-image.png) for predictable URLs.