https://github.com/ytori/mdsite-stack

A simple and customizable template for creating documentation sites with React Router v7.
https://github.com/ytori/mdsite-stack

markdown mdx react react-router remix-stack static-site-generator

Last synced: about 1 month ago
JSON representation

A simple and customizable template for creating documentation sites with React Router v7.

• Host: GitHub
• URL: https://github.com/ytori/mdsite-stack
• Owner: ytori
• License: mit
• Created: 2024-11-14T16:52:16.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-30T20:29:48.000Z (about 1 month ago)
• Last Synced: 2024-11-30T21:25:13.891Z (about 1 month ago)
• Topics: markdown, mdx, react, react-router, remix-stack, static-site-generator
• Language: TypeScript
• Homepage: https://mdsite-stack.vercel.app
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MDSite Stack

**M**ark**D**own + Static **Site** Generation = **MDSite** Stack

## What is this?

MDSite Stack is a simple and customizable template for creating documentation sites with [React Router v7](https://reactrouter.com/).

## Live Demo

https://mdsite-stack.vercel.app

## Quick Start

```sh

npx create-react-router@latest --template ytori/mdsite-stack

```

## Features

- Easily create documentation sites from Markdown

- Simple, minimal, and easy to understand and customize

- Faster initial load due to React Router v7's new [prerender feature](https://reactrouter.com/how-to/pre-rendering)

## Architecture

- [React Router v7](https://reactrouter.com/)

- [MDX](https://mdxjs.com/)

- [Tailwind CSS](https://tailwindcss.com/) & [Tailwind Typography](https://github.com/tailwindlabs/tailwindcss-typography)

- [shadcn/ui](https://ui.shadcn.com/)

Inspired by [remix-blog-mdx](https://github.com/pcattori/remix-blog-mdx). For the same reason, MDX is handled at build time.