{"id":26078107,"url":"https://github.com/nickaggarwal/open-docs","last_synced_at":"2025-04-11T23:41:06.807Z","repository":{"id":280060286,"uuid":"940849910","full_name":"nickaggarwal/open-docs","owner":"nickaggarwal","description":"A documentation website built with React, TypeScript, Bootstrap, and MDX .","archived":false,"fork":false,"pushed_at":"2025-03-15T20:00:45.000Z","size":967,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T19:37:03.833Z","etag":null,"topics":["documentation","mdx","open-source","react"],"latest_commit_sha":null,"homepage":"https://open-docs.org","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nickaggarwal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-28T23:01:59.000Z","updated_at":"2025-03-15T20:00:49.000Z","dependencies_parsed_at":"2025-03-01T01:25:04.080Z","dependency_job_id":"52715c91-3aaf-4938-88d2-3b1fda61b423","html_url":"https://github.com/nickaggarwal/open-docs","commit_stats":null,"previous_names":["nickaggarwal/open-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickaggarwal%2Fopen-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickaggarwal%2Fopen-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickaggarwal%2Fopen-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickaggarwal%2Fopen-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nickaggarwal","download_url":"https://codeload.github.com/nickaggarwal/open-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497901,"owners_count":21113982,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","mdx","open-source","react"],"created_at":"2025-03-09T03:49:46.042Z","updated_at":"2025-04-11T23:41:06.780Z","avatar_url":"https://github.com/nickaggarwal.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Open Docs\n\nA documentation website built with React, TypeScript, Bootstrap, and MDX, inspired by Docusaurus.\n\n## Features\n\n- 📝 MDX for content authoring\n- 🎨 Material UI for styling\n- 🧭 JSON-driven navigation (top bar and sidebar)\n- 📱 Responsive design\n- 🔍 Search functionality\n- 🌙 Dark/Light mode toggle\n\n## Project Structure\n\n```\nopen-docs/\n├── public/              # Static assets\n├── src/\n│   ├── components/      # Reusable UI components\n│   ├── layouts/         # Page layout components\n│   ├── pages/           # React components for each route\n│   ├── content/         # MDX content files\n│   ├── data/            # JSON configuration files\n│   ├── theme/           # Material UI theme customization\n│   ├── App.tsx          # Main application component\n│   └── index.tsx        # Entry point\n└── package.json         # Project dependencies and scripts\n```\n\n## Getting Started\n\n1. Install dependencies:\n   ```bash\n   npm install\n   # or\n   yarn install\n   ```\n\n2. Start the development server:\n   ```bash\n   npm start\n   # or\n   yarn start\n   ```\n\n3. Build for production:\n   ```bash\n   npm run build\n   # or\n   yarn build\n   ```\n\n## Adding Content\n\n1. Create new MDX files in the `src/content` directory\n2. Update navigation in `src/data/navigation.json`\n3. Add new routes in `src/App.tsx` if needed\n\n## Customization\n\n- Modify the theme in `src/theme/theme.ts`\n- Update site metadata in `public/index.html`\n- Customize components in the `src/components` directory \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickaggarwal%2Fopen-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickaggarwal%2Fopen-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickaggarwal%2Fopen-docs/lists"}