More Premium Hugo Themes Premium Nextjs Themes

Next.js

Markdoc plugin for Next.js

Next.js

Markdoc plugin for Next.js

Author Avatar Theme by markdoc
Github Stars Github Stars: 156
Last Commit Last Commit: Mar 10, 2025 -
First Commit Created: Aug 27, 2024 -
default image

Overview:

The @markdoc/next.js plugin is a tool designed for creating custom .md and .mdoc pages within Next.js applications and automatically rendering them with markdoc. Although the plugin is still in beta until version 1.0.0 is released, it offers a convenient solution for incorporating markdown files in Next.js projects.

Features:

  • Custom Markdown Pages - Create custom .md and .mdoc pages within Next.js apps.
  • Automatic Rendering - The plugin automatically renders the markdown files using markdoc.
  • Contribution Guidelines - Clear instructions for contributing and providing feedback on the plugin.
  • Code of Conduct - The project has adopted the Stripe Code of Conduct for maintaining a positive community environment.

Installation:

To install @markdoc/next.js and integrate it into your project, follow these steps:

  1. Run the command to install @markdoc/next.js:
npm install @markdoc/next.js
  1. Open your next.config.js file and add the following code:
// Add @markdoc/next.js configuration here
  1. Create a new Markdoc file in your project under pages/docs named getting-started.md and add content to it.

  2. To contribute or provide feedback, follow these steps:

    npm install
    npm test
    

Summary:

The @markdoc/next.js plugin offers a valuable solution for integrating markdown files into Next.js applications. By following the installation guide and utilizing its features, developers can easily create custom markdown pages with automatic rendering, contributing guidelines, and a defined code of conduct for community participation.