From 993f4a8a2a477e7651fdb474542401cb6bffe59c Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Tue, 19 Mar 2024 10:41:12 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Add=20links=20to=20the=20MyST=20?= =?UTF-8?q?Theme=20documentation=20(#340)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 046232afd..3f214f99f 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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