https://github.com/nickaggarwal/open-docs
A documentation website built with React, TypeScript, Bootstrap, and MDX .
https://github.com/nickaggarwal/open-docs
documentation mdx open-source react
Last synced: about 1 month ago
JSON representation
A documentation website built with React, TypeScript, Bootstrap, and MDX .
- Host: GitHub
- URL: https://github.com/nickaggarwal/open-docs
- Owner: nickaggarwal
- Created: 2025-02-28T23:01:59.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-15T20:00:45.000Z (2 months ago)
- Last Synced: 2025-03-25T19:37:03.833Z (2 months ago)
- Topics: documentation, mdx, open-source, react
- Language: MDX
- Homepage: https://open-docs.org
- Size: 944 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Open Docs
A documentation website built with React, TypeScript, Bootstrap, and MDX, inspired by Docusaurus.
## Features
- 📝 MDX for content authoring
- 🎨 Material UI for styling
- 🧭 JSON-driven navigation (top bar and sidebar)
- 📱 Responsive design
- 🔍 Search functionality
- 🌙 Dark/Light mode toggle
## Project Structure
```
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
```
## Getting Started
1. Install dependencies:
```bash
npm install
# or
yarn install
```
2. Start the development server:
```bash
npm start
# or
yarn start
```
3. Build for production:
```bash
npm run build
# or
yarn build
```
## Adding Content
1. Create new MDX files in the `src/content` directory
2. Update navigation in `src/data/navigation.json`
3. Add new routes in `src/App.tsx` if needed
## Customization
- Modify the theme in `src/theme/theme.ts`
- Update site metadata in `public/index.html`
- Customize components in the `src/components` directory