https://github.com/tyronejosee/project_drf_docs_redesigned
Remastered Django REST Framework documentation using Next.js and MDX. Modern navigation, interactive components, and an optimized developer experience.
https://github.com/tyronejosee/project_drf_docs_redesigned
css django djangorestframework documentation heroui html javascript mdx nextjs python react tailwindcss typescript vercel
Last synced: 2 months ago
JSON representation
Remastered Django REST Framework documentation using Next.js and MDX. Modern navigation, interactive components, and an optimized developer experience.
- Host: GitHub
- URL: https://github.com/tyronejosee/project_drf_docs_redesigned
- Owner: tyronejosee
- Created: 2025-04-22T00:39:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-25T21:22:15.000Z (5 months ago)
- Last Synced: 2026-01-26T12:59:38.341Z (5 months ago)
- Topics: css, django, djangorestframework, documentation, heroui, html, javascript, mdx, nextjs, python, react, tailwindcss, typescript, vercel
- Language: MDX
- Homepage: https://django-rest-framework-redesigned.vercel.app
- Size: 9.5 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Interactive and modern documentation for Django REST Framework, built with Next.js, MDX, and TailwindCSS.
Includes contextual navigation, quick search (Ctrl+K), a dynamic table of contents, and a reading-optimized design.
## ✨ Features
- 📖 **MDX Support** → enriched documentation with code examples.
- 🎨 **Modern and accessible UI** → powered by [HeroUI](https://heroui.io/) and Tailwind.
- 🔍 **Integrated search** with shortcut (`Ctrl + K`).
- 📑 **Dynamic table of contents** highlighting the active section.
- 🧭 **Contextual navigation** (previous / next document).
- 🌙 **Dark mode by default** for comfortable reading.
- ⚡ **Static rendering** with MDX route generation.
## ⚙️ Installation
Clone the repository.
```bash
git clone https://github.com/tyronejosee/project_drf_docs_redesigned
cd your-repo
````
Install dependencies.
```bash
pnpm install
```
Run in development mode.
```bash
pnpm dev
```
Build for production.
```bash
pnpm build
pnpm start
```
## 🌱 Contributing
Contributions are welcome!
You can open an **issue** or a **pull request** to suggest improvements to the documentation or the user experience.
## ⚖️ License
This project follows the license of the official [Django REST Framework](https://github.com/encode/django-rest-framework) repository.