A lightweight documentation system for Next.js applications.
Visit the GitHub Repository for the latest updates and source code.
- 📝 Markdown & MDX support
- 🎨 Clean, modern design
- 🔍 Full-text search
- 📱 Mobile-first responsive layout
- 🌙 Dark mode support
- 📖 Simple documentation structure
# Install with your preferred package manager
npm install cometdocs
# or
yarn add cometdocs
# or
pnpm add cometdocsCreate your documentation directory:
mkdir -p docs/enAdd your first documentation file:
---
title: Welcome
synopsis: Welcome to your documentation
position: 1
---
# Welcome
This is your first documentation page.Create the documentation route:
// app/docs/[[...slug]]/page.tsx
import { CometDocs } from 'cometdocs';
interface DocsPageProps {
params: {
slug: string[];
};
}
export default async function DocsPage({ params }: DocsPageProps) {
const slug = params?.slug?.join('/') || 'index';
return <CometDocs slug={slug} />;
}You can find a complete example implementation in the /example directory. This example shows:
-
Full documentation site setup
-
Custom templates
-
Markdown style guide
-
Writing guidelines
-
Configuration examples
To run the example:
cd example
pnpm install
pnpm devThen visit http://localhost:3000/docs to see it in action.
Visit our documentation site to learn more about:
- Next.js 14 or higher
- Node.js 18.17 or higher
- React 18 or higher
MIT © CometDocs