Skip to content

Commit

Permalink
📖 Add links to the MyST Theme documentation (#340)
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf authored Mar 19, 2024
1 parent a94ea93 commit 993f4a8
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/executablebooks/myst-theme/blob/main/LICENSE)
[![CI](https://github.com/executablebooks/myst-theme/workflows/CI/badge.svg)](https://github.com/executablebooks/myst-theme/actions)

Packages for creating MyST websites themes using React and Remix
Packages for creating MyST websites themes using React and Remix.

[The MyST Theme components documentation](https://executablebooks.github.io/myst-theme/?path=/docs/components-introduction--docs) is the best way to visualize the style and structure of components.

# Development

Expand Down Expand Up @@ -75,6 +77,7 @@ npm run build
### Develop

These packages are best shown using `storybook` a UI library that powers the docs.
This is the same tool that powers [the MyST Theme components documentation](https://executablebooks.github.io/myst-theme/?path=/docs/components-introduction--docs).

```
npm run storybook
Expand Down

0 comments on commit 993f4a8

Please sign in to comment.