CornDocs is a documentation website template built with Next.js and Tailwind CSS that converts Markdown/MDX files from a _posts folder into a searchable, dark-mode-ready documentation site. It is published on GitHub by dishwasher-detergent under the CornDocs repository, and its README describes it with the tagline "Documentation Made Easy."
What is CornDocs?
CornDocs is a documentation website template that takes Markdown/MDX content files as input and produces a static documentation site with sidebar navigation, a customizable home page, and full-text search. It runs on Next.js, so it supports server-side rendering and static generation, and it uses Tailwind CSS for styling. You control the site through one configuration file, corndocs.config.js, and by adding .mdx files under the _posts directory. The template is developed on GitHub and can be deployed to Vercel with a single click.
Key Features
- Next.js framework — Built on Next.js, enabling static generation and fast page loads for documentation content.
- Tailwind CSS styling — The UI is styled with Tailwind CSS; you can change the accent color by editing the primary color in tailwind.config.js.
- Markdown/MDX content — Write docs as .mdx files under _posts, with frontmatter fields for title, description, banner, tags, date, and sidebar position.
- Algolia search — Search is powered by Algolia and configured with four environment variables: admin key, app ID, search API key, and index name.
- Dark mode — Dark mode is enabled by default through the darkMode flag in corndocs.config.js.
- Sidebar ordering — Set the position key in frontmatter for files or in define.json for folders to control sidebar order.
- Customizable homepage — The landing page displays a title and tagline from the configuration, with an optional custom home page path.
- One-click Vercel deploy — The repository includes a Vercel deploy button that clones the repo and asks for the required Algolia environment variables.
Who is it for?
- Open-source developers — publish polished documentation for their GitHub repositories without building a docs site from scratch.
- Startups and product teams — create product documentation, API guides, and onboarding pages using Markdown/MDX and a simple config file.
- Technical writers — write documentation locally, preview changes with npm run dev, and ship updates by pushing to Git or deploying to Vercel.
- Indie hackers — spin up a personal knowledge base or project wiki with dark mode and search included.
What can you do with CornDocs?
- Document a GitHub project: Drop .mdx files into the _posts folder, set their position in frontmatter, and get a clean docs site ready to link from your repo.
- Build a multi-section knowledge base: Nest folders inside _posts to organize content, and assign banner images per folder via define.json or file frontmatter.
- Customize the brand: Replace the SVG logo in public/static, set the site name in the config, and change the primary Tailwind color to match your product.
- Deploy in one click: Use the Vercel deploy button to go from repository to live site, entering only the four Algolia environment variables.
How does CornDocs work?
CornDocs reads Markdown/MDX files from the _posts directory at build time. Each file's frontmatter supplies metadata such as title, description, banner, and position. The corndocs.config.js file controls the project name, GitHub link, logo, and Algolia search settings. Run npm run dev to preview locally at localhost:3000/getting-started, then deploy to Vercel with the provided button.
Alternatives
- Docusaurus — a React-based documentation generator maintained by Meta.
- Nextra — a Next.js-powered documentation template that also supports MDX.
- VitePress — a Vue-powered static site generator focused on documentation.
FAQ
Does CornDocs require Algolia to work?
Yes, the search feature depends on four Algolia environment variables: the admin key, app ID, search API key, and index name. The site will still build without them, but search will not function until they are configured.
Can I use CornDocs without the command line?
Yes. The Vercel deploy button clones the CornDocs repository and guides you through setting the required environment variables in the Vercel dashboard, so you can deploy without touching a terminal.
What file format does CornDocs use for content?
Documentation is written in Markdown/MDX format with the .mdx file extension. Each file can include frontmatter for title, description, banner, tags, date, and position, and files can be nested in folders under _posts.
How do I change the logo?
Place your own SVG logo at public/static/logo.svg. The documentation specifies that the logo must be in SVG format, and its size is controlled in the project config.
