myst-theme

Base repositories for working with MyST websites themes using React.

Development

All dependencies for myst-theme are included in this repository (a monorepo!).

What's inside?

• providers: React providers for references and site configuration
• myst-to-react: expose MyST content as an article, built with React
• site: components and utilities for building React and Remix sites

Each package and app is 100% TypeScript and is provided as uncompiled tsx files.

Versioning & Publishing

myst-theme uses changesets to document changes to this monorepo, call npm run changeset and follow the prompts. Later, npm run version will be called and then npm run publish.

Utilities

myst-theme is built and developed using:

• React for component rendering
• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd myst-theme
npm run build

Develop

These packages are best shown using storybook a UI library that powers the docs.

cd myst-theme
npm run storybook
# and in another terminal
npm run dev