https://github.com/vrepsys/prose-ui-docs-starter
Prose UI docs starter
https://github.com/vrepsys/prose-ui-docs-starter
Last synced: about 2 months ago
JSON representation
Prose UI docs starter
- Host: GitHub
- URL: https://github.com/vrepsys/prose-ui-docs-starter
- Owner: vrepsys
- License: mit
- Created: 2024-12-03T12:29:46.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-02T09:31:57.000Z (2 months ago)
- Last Synced: 2025-02-02T10:27:06.548Z (2 months ago)
- Language: TypeScript
- Homepage: https://prose-ui-docs-starter.vercel.app
- Size: 9.27 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-devtools - Prose UI docs starter - A documentation starter template with Next.js and Prose UI. (Front-End / UI Components)
README
## Prose UI Docs Starter
This is a documentation starter template with [Next.js](https://nextjs.org) and [Prose UI](https://prose-ui.com).
MDX content for this template can be visually edited using [Dhub's WYSIWYG editor](https://dhub.dev).
[Preview template](https://prose-ui-docs-starter.vercel.app)
## Tech stack
[Next.js 15](https://nextjs.org)\
The backbone of the site. Pre-renders pages at build time for fast production performance.
[Prose UI](https://prose-ui.com)\
Provides components and styles for building clean, MDX-powered documentation.
[TailwindCSS](https://tailwindcss.com)\
Facilitates flexible and efficient styling.
[Shadcn UI](https://ui.shadcn.com)\
Includes familiar, shadcn-inspired components.
[Content Collections](https://www.content-collections.dev)\
Renders MDX files with `mdx-bundler` and helps manage frontmatter.
[MDX v3](https://mdxjs.com)\
Combines Markdown and JSX for interactive, component-based content.
[Radix](https://mdxjs.com)\
Provides accessible components used for key elements in this template.
---
## Key features
**WYSIWYG editor**\
Edit your Prose UI MDX files with [Dhub's](https://dhub.dev) WYSIWYG editor.
**Dark mode**\
Light and dark modes powered by [next/themes](https://github.com/pacocoursey/next-themes).
**Content folder**\
Content (MDX files) is separated into a dedicated content folder, making it much easier to manage than scattered `page.mdx` files.
**Table of contents**\
A TOC component on the right helps navigate page content effortlessly.
**Code highlighting**\
[Shiki](https://shiki.style/)-powered server-side code highlighting (via Prose UI).
**Hierarchical sidenav**\
Organize your navigation into categories, folders, and files.
**Customizable theme**\
Customize the look and feel using pre-defined [CSS variables](https://prose-ui.com/docs/styling).
**SEO-friendly**\
Pre-generated pages ensure fast performance and allow search engines to easily index fully-rendered content.
**Blazing fast**\
Next.js performance optimizations make the site extremely fast with virtually instant page navigation.
**Search** \
Coming soon
**API reference docs**\
Coming soon
# Get started
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.