react-docs-ui
v0.7.5
Published
React documentation site UI components — navigation, sidebar, search, code highlight, MDX rendering and theming to help you build docs fast.
Downloads
3,652
Maintainers
Readme
English | 简体中文
react-docs-ui
React documentation site UI components. Build modern docs sites with a ready-to-use app shell.
Install
pnpm create react-docs-ui my-docsQuick Start
Use the official scaffolding tool. Manual integration is no longer recommended because configuration parsing and runtime behavior depend on the generated project structure.
cd my-docs
pnpm install
pnpm devFeatures
- Configuration-driven via
site.yaml - MD/MDX with syntax highlighting
- Light/dark themes
- Command menu (Cmd+K)
- Context menu
- Internationalization
- Table of contents
- PWA support
- AI integration (requires API key)
AI Agent Skills
We provide AI Agent Skills to help you work more efficiently with react-docs-ui:
These skills can help you:
- 📝 Write configuration files
- 📚 Write documentation
- 🚀 Create new projects
Visit the Skills repository to learn more.
Exports
- Layout:
DocsLayout - App shell:
DocsApp - Navigation:
HeaderNav,SidebarNav,TableOfContents - Theming:
ThemeProvider,ModeToggle,LanguageSwitcher - Markdown:
MdxContent - Primitives:
ScrollArea,Tooltip,Dialog,DropdownMenu,Command,ContextMenu
License
MIT
