remove stories, add docs

learningequality · Mar 16, 2022 · 20b20ff · 20b20ff
1 parent 66557d6
commit 20b20ff
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 95 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,6 @@ docs/jsdocs.js
 # IDE
 .idea
 kolibri-design-system.iml
+
+# ignore storybook stories
+stories/
diff --git a/README.md b/README.md
@@ -263,3 +263,12 @@ yarn run devserver
 ```
 
 Now you're all set to see your changes to the Kolibri Design System working live in Kolibri!
+
+
+### Using Storybook locally 
+
+The Kolibri Design System is configured with [Storybook](https://storybook.js.org/) and can be used locally. This is a tool designed to give you a chance to play with and tests components and the various combinations of props they might be configured with.
+
+In order to make use of this tool, you will need to create a `stories/` directory in the root of your KDS repository. Inside of that folder, you can create any number of `*.stories.js` files according to the [Storybook VueJS docs](https://storybook.js.org/docs/vue/writing-stories/introduction). __Note: The `stories/` directory is included in the .gitignore, so these will not be committed along with any of your other work.__
+
+Once you have stories created, you can run `yarn storybook` to start a server, which will open in your browser a window showing all of the stories you've created.
diff --git a/stories/KButton.stories.js b/stories/KButton.stories.js