Overview
The myst-theme is a robust and flexible solution for anyone looking to enhance their website with React components utilizing the MyST AST. This repository not only provides a React renderer capable of turning MyST node types into interactive components but also offers two distinct themes—book and article—that leverage the power of Remix to create unique web experiences. With an emphasis on testing and development, this package keeps pace with the latest innovations in the MyST Engine.
For developers, the myst-theme serves as a comprehensive resource that simplifies theme implementation and documentation. Whether you’re a seasoned creator or just beginning your journey with MyST, this repository has the tools you need for local development, deployment, and more.
Features
- React Renderer: Converts MyST AST node types into functional React components, streamlining your design process.
- Two Distinct Themes: Offers both book and article themes that are built to provide versatile website experiences.
- Integration with Remix: Utilizes the Remix framework to enhance the routing and server-side rendering capabilities of your projects.
- Comprehensive Documentation: Includes a thorough guide for both local development and deployment, ensuring a smooth user experience.
- Monorepo Structure: All necessary dependencies and core themes are housed in one repository, simplifying management and updates.
- Live Server Preview: Facilitates immediate feedback during development with options for live previews of your changes.
- Storybook Integration: Access a dedicated storybook site to explore the various components’ styles and structures before implementation.
- Buffer Adjustment Command: Provides a command to adjust git buffer size for large diffs, preventing potential hangs during deployment.
