Skip to content

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

License

Notifications You must be signed in to change notification settings

juanpablocs/papyrum

 
 

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

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 97.8%
  • JavaScript 1.7%
  • HTML 0.5%