A documentation website built with React, TypeScript, Bootstrap, and MDX, inspired by Docusaurus.
- 📝 MDX for content authoring
- 🎨 Material UI for styling
- 🧭 JSON-driven navigation (top bar and sidebar)
- 📱 Responsive design
- 🔍 Search functionality
- 🌙 Dark/Light mode toggle
open-docs/
├── public/ # Static assets
├── src/
│ ├── components/ # Reusable UI components
│ ├── layouts/ # Page layout components
│ ├── pages/ # React components for each route
│ ├── content/ # MDX content files
│ ├── data/ # JSON configuration files
│ ├── theme/ # Material UI theme customization
│ ├── App.tsx # Main application component
│ └── index.tsx # Entry point
└── package.json # Project dependencies and scripts
-
Install dependencies:
npm install # or yarn install
-
Start the development server:
npm start # or yarn start
-
Build for production:
npm run build # or yarn build
- Create new MDX files in the
src/content
directory - Update navigation in
src/data/navigation.json
- Add new routes in
src/App.tsx
if needed
- Modify the theme in
src/theme/theme.ts
- Update site metadata in
public/index.html
- Customize components in the
src/components
directory