Next.jsReactDocumentation

next-app-nextra-template — Next.js Documentation Template

By gfazioli

A documentation site template based on Next.js App Router, Mantine, and Nextra, with a development toolchain configuration including Storybook, Jest, and Pagefind search.

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

2 previews
Desktop homepage1 / 2
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 2

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-02View source

What stands out

A quick read of the recorded project description.

01

Next.js App Router and Nextra documentation site coexist in the same project

02

Dark mode is synchronized between the Mantine component library and Nextra documentation

03

The content directory uses .mdx and _meta.ts to organize documentation content

04

Built-in Pagefind server-side search index, generated at build time

05

Provides Storybook, Jest, and React Testing Library development and test configuration

06

Integrates the GitHub Release Notes API to display release information in the documentation

Template Details

This template places a Next.js App Router application and a Nextra documentation site in the same project. The UI layer uses the Mantine component library, and theme synchronization allows the documentation and application to share dark mode. The repository structure is divided by responsibility: the app directory holds App Router pages, layouts, and API routes; components holds components shared by the documentation and application; content holds Nextra's .mdx and _meta.ts content files; and config centrally manages site metadata, the GitHub API, and search configuration.

On the documentation side, it provides replaceable navigation and footer components and integrates a GitHub Release Notes API to display version release information in the documentation. The build process includes Pagefind to generate a server-side search index, and also provides a Storybook component development environment, Jest and React Testing Library test configuration, and scripts for oxlint, oxfmt, Stylelint, and TypeScript type checking.

The template targets developers who need to maintain both a product application and accompanying documentation, and is suitable as a starting point for replacing content and configuration. The repository does not provide a business data layer, authentication, or deployment solution; actual use requires supplementing these according to your own needs.

Next.jsReactDocumentation

Is it right for your project?

Use Cases

  • Building an accompanying documentation site for an existing Next.js application
  • Needing a monorepo structure that contains both application pages and MDX documentation
  • Wanting the documentation and application to share the same set of Mantine components and theme
  • Needing to display version release records from a GitHub repository in the documentation

Suitable For

  • Frontend project teams using Next.js App Router
  • Developers who need to maintain product documentation and example pages
  • Frontend engineers who prefer the Mantine component library and want unified documentation styling

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    The repository uses the MIT license; copyright and license notices must be retained when distributing the code

  2. 2

    Third-party assets such as demo images, fonts, and icons need their licenses checked separately

  3. 3

    External services such as domains, hosting, databases, or AI may incur separate charges

  4. 4

    Sponsorship and promotional content in the README does not affect the use of the template itself

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is the code of this version and does not mean external services or third-party assets are free.

Must comply with when using

  • You are allowed to freely use, modify, commercialize, and distribute the code of this version.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the complete MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Sponsorship requests in the README are voluntary and do not constitute usage restrictions; the template code itself can be used for free.
  • The GitHub Release Notes display feature in the documentation depends on the GitHub API and may require network access and corresponding API quota.
  • Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses and cannot be judged solely by the code's MIT license.
  • External services such as domains, hosting, databases, payments, or AI may incur additional charges.
View Original Text Basis

Compiled by DeepSeek based on repository license and README ·2026-10-02. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
GitHub
Documentation and maintenance reference score
More documented · 92 / 100
Technologies
Next.js · React
Website type
Documentation
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2026-10-02
Screenshot last checked
2026-10-02

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Next.js as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Automatically checked against source and license rules; no manual editorial review.

Inspect the recorded source material

SHA-256: ca0b0bb55668369ee8831397f999e9b71b5310c65fc16082e55c68eb240adbe3

2026-10-02T16:40:22.585Z

Source file / repository
# Mantine Next.js + Nextra template

<img width="1536" height="2044" alt="image" src="https://github.com/user-attachments/assets/008eb9b9-ba86-42b6-a5c6-72db3c21bc61" />


<div align="center">

[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)

</div>

This is a template for [Next.js](https://nextjs.org/) app router + [Mantine](https://mantine.dev/) + [Nextra](https://nextra.site/) documentation site.

## Features

This template comes with the following features:

- [Next.js 16](https://nextjs.org/) with App Router and Turbopack
- [Mantine 9](https://mantine.dev/) UI component library
- [Nextra 4](https://nextra.site/) documentation framework with Mantine theme sync
- [PostCSS](https://postcss.org/) with [mantine-postcss-preset](https://mantine.dev/styles/postcss-preset)
- [TypeScript 6](https://www.typescriptlang.org/)
- [Storybook](https://storybook.js.org/)
- [Jest](https://jestjs.io/) setup with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
- [oxlint](https://oxc.rs/docs/guide/usage/linter) for linting
- [oxfmt](https://oxc.rs/docs/guide/usage/formatter) for formatting
- [Pagefind](https://pagefind.app/) server-side search API
- Turbopack inline SVG loader [turbopack-inline-svg-loader](https://github.com/vitalets/turbopack-inline-svg-loader)

## Nextra Features

- [Nextra](https://nextra.site/) documentation site with Mantine theme
- Sync Dark mode between documentation and application (Mantine/Nextra)
- Customizable components in `components` folder
- Custom Navigation and Footer components for Nextra documentation site
- GitHub Release Notes integration via API

## Folder structure

- `app` – Next.js App Router pages, layouts, and API routes
- `components` – shared components (usable in both documentation and application)
- `content` – Nextra documentation site (`.mdx` and `_meta.ts` files)
- `config` – centralized site configuration (metadata, GitHub API, search)

## npm scripts

### Build and dev scripts

- `dev` – start dev server
- `build` – bundle application for production (includes pagefind search index)
- `analyze` – analyzes application bundle with [@next/bundle-analyzer](https://www.npmjs.com/package/@next/bundle-analyzer)

### Testing scripts

- `typecheck` – checks TypeScript types
- `lint` – runs oxlint and Stylelint
- `format:test` – checks files with oxfmt
- `jest` – runs jest tests
- `jest:watch` – starts jest watch
- `test` – runs `format:test`, `lint`, `typecheck` and `jest` scripts

### Other scripts

- `storybook` – starts storybook dev server
- `storybook:build` – build production storybook bundle to `storybook-static`
- `format:write` – formats all files with oxfmt

## Sponsor

<div align="center">

[<kbd> <br/> ❤️ If this component has been useful to you or your team, please consider becoming a sponsor <br/> </kbd>](https://github.com/sponsors/gfazioli?o=esc)

</div>

Your support helps me:

- Keep the project actively maintained with timely bug fixes and security updates
- Add new features, improve performance, and refine the developer experience
- Expand test coverage and documentation for smoother adoption
- Ensure long‑term sustainability without relying on ad hoc free time
- Prioritize community requests and roadmap items that matter most

Open source thrives when those who benefit can give back—even a small monthly contribution makes a real difference. Sponsorships help cover maintenance time, infrastructure, and the countless invisible tasks that keep a project healthy.

Your help truly matters.

💚 [Become a sponsor](https://github.com/sponsors/gfazioli?o=esc) today and help me keep this project reliable, up‑to‑date, and growing for everyone.
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.