Yuri's Empathetic Arbitrary Syntax Tree (yeast) is a common structure for describing content documents. This project contains TypeScript packages for parsing to and rendering from yeast document definitions. The primary pipeline is from Markdown to React, but the packages are modular support future expansion and additional use cases.
core components and common types for working with yeast documents
parses markdown to a yeast document
renders a yesat document to markdown
renders a yeast document to react
See the README in each package's folder for package-specific instructions.
Coming Soon™
Public contributions are welcome! Breaking changes should be discussed first.
- Only make updates to one package per branch/PR
- Update tests whenever you make changes
- Bump package versions per semantic versionning rules
- major - not backwards compatible/breaking change
- minor - new features, backwards compatible/non-breaking
- point - bugfixes, backwards compatible/non-breaking
- Publish a pre-release version before creating a PR (Genesys only)
- Update documentation to reflect changes
New versions are published to NPM by the Genesys Developer Engagement team.
No formal support is offered for this project. If you encounter problems with any of the packages, please create issues in this repo.