From 10f807a19f32dba377cf6d0280bbe3eb6486578d Mon Sep 17 00:00:00 2001 From: Vincent Petry Date: Mon, 23 Nov 2020 20:05:17 +0100 Subject: [PATCH] Add notes about styleguide command in README To make it a bit more obvious. Signed-off-by: Vincent Petry --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index dead252793..c8bdd73fc5 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,12 @@ If you want to work on improving the components it’s best to run the latest co - In the repository of an app do `npm link @nextcloud/vue` (you need to re-link any time you do `npm ci` in the app) 4. Then build the app with: `npm run build` (or watch for changes with `npm run watch`) +### Styleguide + +When developing new components or extending compnents, make sure to also have some bits of related documentation like examples, where applicable. +To test components and the documentation in that context, you can run `npm run styleguide` to run a local server that serves the style guide +with all the components. + ### Using vue-devtools in Firefox If you want to use [vue-devtools](https://github.com/vuejs/vue-devtools) in Firefox, you need to patch your nextcloud instance as follow: