Skip to content
 
 

Repository files navigation

Papyrum is a tool that will help you in the creation of your design system, style guide or in the documentation of your project based on react

Features

  • Zero config
  • MDX based, builds documentation with the markdown of the component era.
  • Typescript support

Installation

npm i @papyrum/cli @papyrum/ui-docs -D -E

You need react y react-dom with 16.8.6 installed.

Usage

Add the following to your package.json

{
  "name": "my_project",
  "scripts": {
    "dev": "papyrum dev",
    "build": "papyrum build"
  }
}

Hello world with papyrum, create one file .mdx

---
name: Hello world
---

# Hello world

Hello world with mdx

execute

yarn dev

Examples

About

Papyrum is a tool that will help you in the creation of your design system, style guide or in the documentation of your project based on react

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages