Skip to content

development.md

Latest commit

 

History

History
63 lines (48 loc) · 1.58 KB

development.md

File metadata and controls

63 lines (48 loc) · 1.58 KB
Raw

Development

The site is built with Next.js and Nextra, a documentation framework. Content is written in MDX (Markdown + JSX) in the src/content/ directory.

Project structure:

  • src/content/ - MDX content files
  • src/content/_meta.ts - Page configuration (titles, navigation)
  • src/app/ - Next.js App Router structure
  • src/components/ - React components
  • public/ - Static assets

Git hooks: This project uses Lefthook for Git hooks:

  • Pre-commit: Runs ESLint auto-fix and TypeScript type checking
  • Commit-msg: Validates conventional commit format

LAN access

To open the dev server through a LAN address, set NEXT_ALLOWED_DEV_ORIGINS=192.168.1.10 in .env.local, using your server's IP or hostname, then restart pnpm dev. Separate multiple hosts with commas.

Building and testing

Build the site:

pnpm build

This generates a static export in the ./out directory.

Lint your code:

pnpm lint          # Check for errors
pnpm lint:fix      # Auto-fix errors

Type check:

pnpm run check:types

Check for unused dependencies:

pnpm run check:deps

Analyze bundle size:

pnpm run analyze

Deployment

The site is automatically deployed to GitHub Pages when changes are pushed to the develop branch. The CI workflow:

  1. Runs linting and type checking
  2. Builds the static site
  3. Deploys to GitHub Pages

You can preview the production build locally by serving the ./out directory:

npx serve ./out