A high-performance, beautiful documentation starter powered by Vite, Tailwind CSS and MDX.
To get started, make sure you have Node.js and pnpm installed on your system. Then, follow these steps:
git clone https://github.com/area44/vite-monopage.git
cd vite-monopage
pnpm install
pnpm dev
pnpm buildvite-monopage/
├── .github/ # GitHub actions CI/CD workflows
├── public/ # Static assets and media files
├── src/ # Main application source code
│ ├── components/ # Custom React components and reusable UI blocks
│ ├── lib/ # Standard utilities
│ ├── pages/ # MDX document files
│ ├── plugins/ # Markdown processing plugins
│ ├── styles/ # Application stylesheets
│ ├── app.tsx # Core page
│ ├── main.tsx # Client-side mounting entry point
│ ├── mdx-components.tsx # Custom React elements dictionary for MDX tags
│ ├── mdx.d.ts # TypeScript definition module for *.mdx files
│ └── vite-env.d.ts # Vite client type references
├── AGENTS.md # Onboarding guide for AI developer agents
├── README.md # Main project introduction
├── index.html # Core HTML file containing root mount element
├── package.json # Dependencies, scripts, and package information
├── pnpm-workspace.yaml # Workspace settings
├── tsconfig.json # Project-wide TypeScript compiler settings
└── vite.config.ts # Vite configurations
Your main documentation content lives in src/pages/index.mdx. Simply edit this file to update your site. The page title and description are managed via frontmatter.
You can create new React components in src/components and register them in src/mdx-components.tsx. Once registered, they are available to use directly in your MDX files.
Distributed under the MIT License. See LICENSE for more information.