Skip to content

README.md

Latest commit

 

History

History
54 lines (39 loc) · 1.46 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.46 KB

eventkit Documentation Site

This directory contains the Nextra-based documentation site for eventkit.

Development

# Install dependencies
pnpm install

# Start dev server
pnpm dev

# Build for production
pnpm build

The dev server will start at http://localhost:3000

Technology Stack

  • Nextra v4.0.0 - Documentation framework
  • Next.js 15.1.6 - React framework
  • React 19 - UI library
  • pnpm - Package manager

Project Structure

docs/
├── app/                    # Next.js app directory
│   ├── layout.tsx         # Root layout with navigation
│   └── [[...mdxPath]]/    # Dynamic MDX page routing
├── content/               # MDX documentation files
│   ├── _meta.json        # Navigation structure
│   └── *.mdx             # Documentation pages
├── public/               # Static assets
├── next.config.mjs       # Next.js configuration
├── tsconfig.json         # TypeScript configuration
└── package.json          # Dependencies and scripts

Deployment

The site is automatically deployed to GitHub Pages at https://prosdevlab.github.io/eventkit/ when changes are pushed to the main branch.

Adding Content

  1. Create an MDX file in content/
  2. Add navigation entry to content/_meta.json
  3. Write content using MDX syntax
  4. Test locally with pnpm dev

See Nextra documentation for more details on MDX features and components.