Skip to content

Foveluy/ReStory

Repository files navigation

Restory

Restory (AKA ReactStory) is an extremely lightweight static document generator that supports writing React components directly in Markdown.

Document

see the Document on Gitpage

How does it work

Restory is a single-page application driven by React, React Router, Webpack, and Node.js. Restory will complete the rendering of the page during the building phase, providing a superb browsing experience and very good search engine optimization (SEO) for the production environment.

Features

  • The ability of writing React components directly in Markdown.
  • Provides server-side rendering (SSR) and client-side rendering (CSR)
  • Built-in Markdown extension optimized for technical documentation
  • Multi-language support
  • Automatically generate service workers
  • Google Analytics
  • React-driven custom theme system
  • Search Box
  • docker support

Inspiration

This project is inspired by VuePress and uses MDX to write React subproject documents, making it easy for users to embed their own React components in documents.

About

A static site generator with MDX for React documentation.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published