Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 2.76 KB

README.md

File metadata and controls

89 lines (59 loc) · 2.76 KB
Prose UI social image

Prose UI Docs Starter

This is a documentation starter template with Next.js and Prose UI.

MDX content for this template can be visually edited using Dhub's WYSIWYG editor.

Preview template

Tech stack

Next.js 15
The backbone of the site. Pre-renders pages at build time for fast production performance.

Prose UI
Provides components and styles for building clean, MDX-powered documentation.

TailwindCSS
Facilitates flexible and efficient styling.

Shadcn UI
Includes familiar, shadcn-inspired components.

Content Collections
Renders MDX files with mdx-bundler and helps manage frontmatter.

MDX v3
Combines Markdown and JSX for interactive, component-based content.

Radix
Provides accessible components used for key elements in this template.


Key features

WYSIWYG editor
Edit your Prose UI MDX files with Dhub's WYSIWYG editor.

Dark mode
Light and dark modes powered by 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-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.

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

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 from the creators of Next.js.

Check out Next.js deployment documentation for more details.