CONTRIBUTING.md

Contributing

Getting started

Fork the project on Github and clone the project from the fork

Setup

Pre-requisites

• Node: 10.16.0 or higher
• Yarn: 1.17.0 or higher

Starting the project

yarn install
yarn build
yarn bs

Development server and watching

This command will start the development server with the basic example and watching changes in all packages

yarn dev

Go to http://localhost:4000/ you will see the basic example

Packages

papyrum-cli

Command line logic and root root component.

papyrum-core

Compilation logic, development server, mdx reading.

papyrum-ui-docs

Ccomponents that help document better with papyrum.

papyrum-ui

Components used by the papyrum tool, toolbar, sidebar, h1, h2 for content mdx, etc.

Commit messages

Confirmation messages must follow the following convention

Pull Requests

• All extraction requests must be sent to the branch dev
• Be sure to work in the src folder and not in the dist

New Feature

First create an issue and explain the new feature once it is approved you can start working on it

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Wilson FT 💻 📖 👀 🎨

Juan pablo 💻 👀

This project follows the all-contributors specification. Contributions of any kind welcome!