An open API service indexing awesome lists of open source software.

https://github.com/noxify/vite-renoun-docs


https://github.com/noxify/vite-renoun-docs

Last synced: 25 days ago
JSON representation

Awesome Lists containing this project

README

          

# Renoun Vite Docs example

## Features

- **renoun**: Create engaging, interactive, and valid content with the renoun toolkit
- **Next.js-like routing** with dynamic parameters (`[slug]`, `[...slug]`) and group support (`(groupname)`)
- **Static Site Generation (SSG)**
- **Automatic route types**: Type-safe `PageProps` for all routes
- **Param support for pages and layouts** (`params`, `searchParams`)
- **MDX with client & server components**

## Installation

```bash
git clone git@github.com:noxify/renoun-vite-docs.git
cd renoun-vite-docs
pnpm i
```

## Quick start

```bash
pnpm dev # Development
pnpm build # SSG/SSR build
pnpm preview # Preview ( via `serve-handler` )
```

## Additional Notes

- This repository is mainly an experiment to implement `renoun` in a Vite app. I highly recommend [Waku](https://waku.gg/), which is also built on top of Vite and works with `renoun`, too
- You should definitely check out [`vite-plugin-rsc-pages`](https://github.com/mrozio13pl/vite-plugin-rsc-pages) if you're looking for a Next.js app router-like page integration
- The router code is inspired by the Next.js implementation and was generated with GitHub Copilot
- This repository is based on the [SSG example from Vite](https://github.com/vitejs/vite-plugin-react/tree/main/packages/plugin-rsc/examples/ssg)

## UI components

- shadcn/ui default components
- https://reui.io/docs/alert
- https://coss.com/origin/stepper
- https://ariadocs.vercel.app/docs/getting-started/components/stepper
- https://github.com/nisabmohd/Aria-Docs/blob/master/components/markdown/stepper.tsx