# shuding/nextra

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/shuding-nextra).**

13,842 stars · 1,411 forks · TypeScript · MIT

## Links

- GitHub: https://github.com/shuding/nextra
- Homepage: https://nextra.site
- awesome-repositories: https://awesome-repositories.com/repository/shuding-nextra.md

## Topics

`markdown` `mdx` `nextjs` `nextra` `react` `static-site-generator`

## Description

Nextra is a documentation framework for Next.js that functions as an MDX static site generator. It enables the creation of structured technical documentation sites by transforming MDX files into themed static pages with built-in layout and navigation. It serves as a React-based documentation tool that allows the integration of custom React components directly into markdown content.

The framework distinguishes itself through integrated full-text search and a localization system that manages multilingual content via language routing and translation selectors. It also includes an AI-powered chat assistance integration to provide instant answers based on site content.

The platform covers extensive content rendering capabilities, including LaTeX mathematical expressions, Mermaid diagrams, and interactive code walkthroughs with type information. It provides specialized layout controls for site-wide navigation, a dedicated blogging system with RSS feeds, and automated API documentation generation from TypeScript definitions.

The project is built with TypeScript.

## Tags

### Content Management & Publishing

- [Technical Content Renderers](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/markdown-markup-tools/markdown-tools/technical-content-renderers.md) — Renders MDX files into themed pages with integrated syntax highlighting and custom alert components. ([source](https://nextra.site/docs/guide))
- [Documentation Site Generators](https://awesome-repositories.com/f/content-management-publishing/documentation-site-generators.md) — Acts as a specialized generator for technical documentation sites with integrated search and navigation.
- [MDX Processors](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/mdx-processors.md) — Transforms MDX files containing React components into themed static HTML pages.
- [Content Directories](https://awesome-repositories.com/f/content-management-publishing/content-formats-exporting/content-formats/content-directories.md) — Maps the physical directory structure of the project to the resulting website URL paths. ([source](https://nextra.site/docs/file-conventions/content-directory))
- [Content Hierarchy Management](https://awesome-repositories.com/f/content-management-publishing/content-hierarchy-management.md) — Structures documentation into a hierarchical tree using folders, index pages, and visual separators. ([source](https://nextra.site/docs/file-conventions/meta-file))
- [Internationalized Web Content](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/internationalized-web-content.md) — Supports multiple languages through integration with localization frameworks to serve content based on user locale. ([source](https://nextra.site/docs/guide))
- [Documentation Metadata Configurations](https://awesome-repositories.com/f/content-management-publishing/documentation-metadata-configurations.md) — Configures site-wide and page-specific head tags, theme colors, and favicons for browser metadata. ([source](https://nextra.site/docs/built-ins/head))
- [File-Based Routing](https://awesome-repositories.com/f/content-management-publishing/file-based-routing.md) — Maps the directory structure of MDX and markdown files directly to the site's URL paths.
- [Markdown Renderers](https://awesome-repositories.com/f/content-management-publishing/markdown-renderers.md) — Transforms extended markdown syntax, including task lists and tables, into formatted HTML. ([source](https://nextra.site/docs/guide/markdown))
- [Multilingual Documentation](https://awesome-repositories.com/f/content-management-publishing/multilingual-documentation.md) — Provides systems for managing and serving technical documentation in multiple languages for global audiences.
- [Content Metadata Management](https://awesome-repositories.com/f/content-management-publishing/page-metadata-optimizations/content-metadata-management.md) — Programmatically extracts and manages page-level metadata from frontmatter for content organization and filtering. ([source](https://nextra.site/docs/blog-theme/get-posts-and-tags))
- [Static Page Rendering](https://awesome-repositories.com/f/content-management-publishing/static-page-rendering.md) — Generate HTML during the build process to improve loading speeds and distribute content through a global caching network. ([source](https://nextra.site/docs/guide/ssg))
- [Static Site Generation](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/static-site-generation.md) — Pre-renders structured documentation files into static HTML pages for optimized load times.
- [Blog Index Generation](https://awesome-repositories.com/f/content-management-publishing/blog-index-generation.md) — Creates a comprehensive blog index with tag counts to help users browse and filter content. ([source](https://nextra.site/docs/blog-theme/posts))
- [Technical Blogs](https://awesome-repositories.com/f/content-management-publishing/blog-post-publishing/technical-blogs.md) — Ships a dedicated blogging system with RSS feeds, tag-based filtering, and chronological post indexes.
- [Blog Feed Generation](https://awesome-repositories.com/f/content-management-publishing/blog-post-rendering/blog-feed-generation.md) — Generates chronological and categorized blog feeds including post tags and metadata. ([source](https://nextra.site/docs/blog-theme))
- [Dynamic Tag Pages](https://awesome-repositories.com/f/content-management-publishing/dynamic-tag-pages.md) — Generates dynamic pages that aggregate and display all blog posts associated with a specific tag or category. ([source](https://nextra.site/docs/blog-theme))
- [Locale Redirections](https://awesome-repositories.com/f/content-management-publishing/locale-redirections.md) — Detects a user's preferred locale via middleware and automatically routes them to the corresponding language version. ([source](https://nextra.site/docs/guide/i18n))
- [GitHub Alert Syntax](https://awesome-repositories.com/f/content-management-publishing/markdown-renderers/github-flavored-renderers/github-alert-syntax.md) — Transforms GitHub-style alert markdown into styled callout components for notes and warnings. ([source](https://nextra.site/docs/guide/github-alert-syntax))
- [Mathematical Notation Renderers](https://awesome-repositories.com/f/content-management-publishing/markdown-renderers/mathematical-notation-renderers.md) — Renders LaTeX mathematical expressions using pre-rendered static output or dynamic browser engines. ([source](https://nextra.site/docs/advanced/latex))
- [Content Presentation Components](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/content-presentation-components.md) — Provides a set of predefined layout components to improve documentation structure and readability. ([source](https://nextra.site/docs/built-ins))
- [Remote Content Rendering](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/mdx-processors/remote-content-rendering.md) — Provides the ability to render compiled MDX strings fetched from remote sources as React components. ([source](https://nextra.site/docs/advanced/remote))

### Web Development

- [Static Site Generators](https://awesome-repositories.com/f/web-development/static-site-generators.md) — Functions as a static site generator that transforms MDX files into themed pages with built-in layout and navigation.
- [Documentation Frameworks](https://awesome-repositories.com/f/web-development/documentation-frameworks.md) — Provides a comprehensive framework for building structured documentation sites using Next.js and MDX.
- [Internationalization Routing](https://awesome-repositories.com/f/web-development/internationalization-routing.md) — Maps content to different locale identifiers and handles language-specific URL paths to serve translated versions. ([source](https://nextra.site/docs/guide/i18n))
- [Page Layout Configurations](https://awesome-repositories.com/f/web-development/layout-engines/page-layout-configurations.md) — Defines the global visual structure, including site-wide navbars, footers, and search bar placement. ([source](https://nextra.site/docs/docs-theme/built-ins/layout))
- [Custom Layout Overrides](https://awesome-repositories.com/f/web-development/layout-engines/page-layout-configurations/custom-layout-overrides.md) — Toggles UI elements like sidebars and footers on a per-page basis to switch between layout modes. ([source](https://nextra.site/docs/file-conventions/meta-file))
- [MDX Components](https://awesome-repositories.com/f/web-development/mdx-components.md) — Allows the integration of custom React components directly into markdown content for interactive documentation.
- [MDX Rendering Frameworks](https://awesome-repositories.com/f/web-development/mdx-rendering-frameworks.md) — Transforms MDX files into structured web pages using pre-defined or custom visual themes. ([source](https://nextra.site/docs))
- [Client-Side Navigation Management](https://awesome-repositories.com/f/web-development/routing-systems/routing/frontend-navigation-systems/client-side-navigation-management.md) — Optimizes documentation browsing by converting markdown links into client-side transitions with prefetching. ([source](https://nextra.site/docs/guide/link))
- [Page Layout Mapping](https://awesome-repositories.com/f/web-development/routing-systems/routing/route-definition-strategies/page-layout-mapping.md) — Allows MDX files to be rendered using unique page layouts to maintain custom UI structures. ([source](https://nextra.site/docs/file-conventions/page-file))
- [Incremental Static Regenerations](https://awesome-repositories.com/f/web-development/static-page-construction/incremental-static-regenerations.md) — Updates cached static pages in the background after data changes without requiring a full site rebuild.

### Part of an Awesome List

- [Code Highlighting](https://awesome-repositories.com/f/awesome-lists/devtools/code-highlighting.md) — Implements build-time syntax highlighting for code blocks, supporting custom grammars and ANSI escape codes. ([source](https://nextra.site/docs/guide/syntax-highlighting))
- [Code Walkthroughs](https://awesome-repositories.com/f/awesome-lists/devtools/onboarding-and-walkthroughs/interactive-walkthroughs/code-walkthroughs.md) — Provides interactive code snippets with guided walkthroughs to explain API usage. ([source](https://nextra.site/docs/advanced))
- [TypeScript Definition Renderers](https://awesome-repositories.com/f/awesome-lists/devtools/templating-and-documentation/api-reference-generators/typescript-definition-renderers.md) — Automatically generates searchable technical references from TypeScript definitions.

### Data & Databases

- [Full Text Search](https://awesome-repositories.com/f/data-databases/full-text-search.md) — Includes an integrated search system that indexes site content and code blocks for instant retrieval.
- [Documentation Search](https://awesome-repositories.com/f/data-databases/full-text-search/documentation-search.md) — Provides a search interface specifically designed for indexing and querying technical documentation content. ([source](https://nextra.site/docs/built-ins/search))
- [Static Content Indexing](https://awesome-repositories.com/f/data-databases/search-indexing-technologies/search-indexing/search-and-indexing/static-content-indexing.md) — Indexes static text files to enable fast retrieval of site content without requiring a backend database. ([source](https://nextra.site/docs/guide))

### Development Tools & Productivity

- [Documentation Navigation](https://awesome-repositories.com/f/development-tools-productivity/documentation-navigation.md) — Automatically generates sidebars and tables of contents to organize and navigate project documentation. ([source](https://nextra.site/docs/docs-theme/built-ins/layout))
- [Developer Portals](https://awesome-repositories.com/f/development-tools-productivity/developer-portals.md) — Facilitates the construction of public resource centers for APIs and libraries with interactive components.
- [Mermaid Diagram Renderers](https://awesome-repositories.com/f/development-tools-productivity/markdown-documentation-systems/diagram-integrations/mermaid-diagram-renderers.md) — Converts Mermaid syntax code blocks into visual diagrams during the static build process. ([source](https://nextra.site/docs/advanced/mermaid))
- [Inline Type Documentation](https://awesome-repositories.com/f/development-tools-productivity/type-hover-information/inline-type-documentation.md) — Renders inline type hovers and error messages within code blocks to provide real-time API documentation. ([source](https://nextra.site/docs/advanced/twoslash))

### Education & Learning Resources

- [Embedded Application Components](https://awesome-repositories.com/f/education-learning-resources/interactive-documentation/embedded-application-components.md) — Integrates custom React components and live coding environments directly into MDX content. ([source](https://nextra.site/docs))

### Software Engineering & Architecture

- [YAML Frontmatter Configurations](https://awesome-repositories.com/f/software-engineering-architecture/application-lifecycle-management/configuration-management/configuration-formats-and-schemas/configuration-formats/yaml-frontmatter-configurations.md) — Uses YAML frontmatter in markdown files to configure page layouts, navigation, and SEO metadata.
- [Multilingual Site Support](https://awesome-repositories.com/f/software-engineering-architecture/infrastructure-configuration-languages/multi-language-support/multilingual-site-support.md) — Enables site-wide multilingual capabilities with translation fallbacks and session persistence. ([source](https://nextra.site/docs/docs-theme/built-ins/layout))
- [Automated API Documentation](https://awesome-repositories.com/f/software-engineering-architecture/automated-api-documentation.md) — Automatically generates technical documentation tables and descriptions directly from TypeScript definitions and TSDoc annotations. ([source](https://nextra.site/docs/built-ins/tsdoc))
- [MDX Component Overrides](https://awesome-repositories.com/f/software-engineering-architecture/component-logic-overrides/mdx-component-overrides.md) — Allows replacing default theme components with custom React components to change how elements are rendered. ([source](https://nextra.site/docs/file-conventions/mdx-components-file))
- [Resource Co-location Patterns](https://awesome-repositories.com/f/software-engineering-architecture/resource-co-location-patterns.md) — Uses co-located configuration files to define navigation and metadata alongside the content they describe.

### User Interface & Experience

- [MDX Component Injection](https://awesome-repositories.com/f/user-interface-experience/custom-element-renderers/custom-component-injection/mdx-component-injection.md) — Enables the integration of interactive React components directly within static markdown documentation.
- [Documentation Layouts](https://awesome-repositories.com/f/user-interface-experience/layout-components/custom-layouts/documentation-layouts.md) — Offers pre-configured layouts specifically designed for technical documentation, including sidebars and search bars. ([source](https://nextra.site/docs/docs-theme/start))
- [Layout Wrappers](https://awesome-repositories.com/f/user-interface-experience/layout-wrappers.md) — Provides a layout wrapper that controls the structural framing for all rendered pages across the site. ([source](https://nextra.site/docs/custom-theme))
- [Navigation Configurations](https://awesome-repositories.com/f/user-interface-experience/navigation-configurations.md) — Uses co-located configuration files to define the structure and visibility of the site navigation. ([source](https://nextra.site/docs/file-conventions/meta-file))
- [Theme Application & Switching](https://awesome-repositories.com/f/user-interface-experience/color-themes/theme-application-switching.md) — Implements a theme switching system allowing users to toggle between light and dark modes. ([source](https://nextra.site/docs/docs-theme/built-ins/layout))
- [Notice Blocks](https://awesome-repositories.com/f/user-interface-experience/content-block-editors/notice-blocks.md) — Includes specialized content blocks for highlighting tips, warnings, and critical notes within documentation. ([source](https://nextra.site/docs/built-ins/callout))
- [Markdown Table Rendering](https://awesome-repositories.com/f/user-interface-experience/data-visualization-tools/data-visualization/specific-chart-types/table-visualizations/markdown-table-rendering.md) — Renders GitHub Flavored Markdown tables into consistently styled grids within MDX content. ([source](https://nextra.site/docs/advanced/table))
- [Navigation Bars](https://awesome-repositories.com/f/user-interface-experience/navigation-components/navigation-bars.md) — Provides a configurable top-level navigation bar with custom logos and navigation links. ([source](https://nextra.site/docs/docs-theme/built-ins/navbar))
- [Site Banners](https://awesome-repositories.com/f/user-interface-experience/notification-banners/site-banners.md) — Renders a prominent notification area at the top of the site for warnings or announcements. ([source](https://nextra.site/docs/built-ins/banner))
- [Page Footers](https://awesome-repositories.com/f/user-interface-experience/page-footers.md) — Adds customizable content and copyright information to the bottom of pages with visibility toggles. ([source](https://nextra.site/docs/docs-theme/built-ins/footer))
- [Page Metadata Retrievers](https://awesome-repositories.com/f/user-interface-experience/page-headers/page-metadata-retrievers.md) — Retrieves page metadata and structural data to dynamically determine layouts and navigation visibility. ([source](https://nextra.site/docs/docs-theme/api))
- [Code Block Annotations](https://awesome-repositories.com/f/user-interface-experience/presentation-frameworks/code-presentation-utilities/code-line-highlighting/code-block-annotations.md) — Enhances code blocks with line numbering, filename titles, and one-click copy functionality. ([source](https://nextra.site/docs/guide/syntax-highlighting))
- [Global CSS Stylings](https://awesome-repositories.com/f/user-interface-experience/styling-theming-systems/content-styling/css-utility-libraries/css-utilities/global-css-stylings.md) — Supports the import of global and modular CSS or Sass files to override default themes. ([source](https://nextra.site/docs/guide/custom-css))
- [Syntax Highlighting Themes](https://awesome-repositories.com/f/user-interface-experience/syntax-highlighting-themes.md) — Allows configuration of code block visual styles using custom themes and CSS variables. ([source](https://nextra.site/docs/guide/syntax-highlighting))
- [Tabbed Content Panes](https://awesome-repositories.com/f/user-interface-experience/tabbed-content-panes.md) — Organizes related information into interactive tabbed layouts for switching between content panes. ([source](https://nextra.site/docs/built-ins/tabs))
- [Utility-First Styling](https://awesome-repositories.com/f/user-interface-experience/utility-first-styling.md) — Integrates utility-first CSS frameworks and Sass to provide granular control over page presentation. ([source](https://nextra.site/docs))
- [Visual Theme Configurations](https://awesome-repositories.com/f/user-interface-experience/visual-theme-configurations.md) — Provides access to global theme settings to dynamically configure visual elements across the documentation site. ([source](https://nextra.site/docs/docs-theme/api))

### Artificial Intelligence & ML

- [AI Chat Assistants](https://awesome-repositories.com/f/artificial-intelligence-ml/ai-chat-assistants.md) — Embeds an AI-powered chat interface into documentation to provide instant answers based on site content. ([source](https://nextra.site/docs/guide/search/ai))

### DevOps & Infrastructure

- [Incremental Bundlers](https://awesome-repositories.com/f/devops-infrastructure/cicd-pipeline-automation/core-build-engines/bundling-extension-architectures/build-tooling-architectures/incremental-bundlers.md) — Uses an incremental bundler to reduce build times and increase the speed of module updates during development. ([source](https://nextra.site/docs/guide/turbopack))
- [Static Exports](https://awesome-repositories.com/f/devops-infrastructure/deployment-management-strategies/static-site-deployments/static-exports.md) — Converts dynamic content into a set of static HTML files for hosting in serverless environments. ([source](https://nextra.site/docs/guide/static-exports))