FAQ

Here you will find answers to common questions about this documentation example. Whether you're just getting started or looking to customize your setup, we've got you covered.

What is this example?

A simple documentation site using renoun, Next.js, and Tailwind CSS. It demonstrates how to create a modern documentation site with features like sidebar navigation, MDX support, and interactive components.

How do I add new docs?

Add new .mdx files to the docs/ directory with the required metadata at the top. Each file should export a metadata object with title, date, and summary fields. The sidebar navigation will be automatically generated based on your file structure.

What features are included?

This example includes:

  • MDX support for rich content
  • Automatic sidebar navigation
  • Dark mode support
  • Responsive design
  • Interactive components like accordions
  • Code syntax highlighting
  • Last updated timestamps
How do I customize the theme?

The theme can be customized through Tailwind CSS configuration. You can modify colors, typography, spacing, and other design tokens in the tailwind.config.js file. The example uses a clean, modern design that's easy to extend.

Can I use custom components in MDX?

Yes! You can use any React component in your MDX files. The example includes several built-in components like Accordion, CodeBlock, and CodeInline. You can also create your own components and use them in your documentation.

How do I deploy this site?

Since this is a Next.js application, you can deploy it to any platform that supports Next.js, such as Vercel, Netlify, or your own hosting solution. The example includes all necessary configuration for production deployment.