diff --git a/README.md b/README.md index a706ebea3..41c966418 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ You can also specify a particular version of the design system. For example, thi yarn add https://github.com/learningequality/kolibri-design-system#v1.0.1 ``` - Importable components and utilities are available under the `lib` path, for example: +Importable components and utilities are available under the `lib` path, for example: ```javascript import KButton from 'kolibri-design-system/lib/KButton'; @@ -66,6 +66,8 @@ cd design-system yarn install ``` +(Note: if you see a timeout error like `ESOCKETTIMEDOUT`, you can configure yarn with a higher timeout value [as described here](https://github.com/yarnpkg/yarn/issues/5540#issuecomment-374069461).) + Run the development server using ```bash @@ -188,7 +190,7 @@ Icons are drawn from https://github.com/material-icons/material-icons and then c yarn run precompile-svgs ``` -We also output a set of reStructuredText replacement strings into the file ``docs/rstIconReplacements.txt`` which can be used in +We also output a set of reStructuredText replacement strings into the file `docs/rstIconReplacements.txt` which can be used in user docs based on Sphinx. To update this file, run ```bash diff --git a/package.json b/package.json index 93b3411f7..ad04e5e03 100644 --- a/package.json +++ b/package.json @@ -22,24 +22,22 @@ "lib" ], "dependencies": { - "@babel/core": "^7.9.6", - "@babel/preset-env": "^7.9.6", - "@mdi/svg": "^5.3.45", "aphrodite": "https://github.com/learningequality/aphrodite/", "autosize": "^3.0.21", "css-element-queries": "^1.2.0", "fuzzysearch": "^1.0.3", "keen-ui": "^1.3.0", "lodash": "^4.17.15", - "material-design-icons": "^3.0.1", "popper.js": "^1.14.6", "purecss": "^0.6.2", - "svgo": "^1.3.2", "tippy.js": "^4.2.1" }, "peerDependencies": {}, "devDependencies": { + "@babel/core": "^7.9.6", + "@babel/preset-env": "^7.9.6", "@material-icons/svg": "git+https://github.com/material-icons/material-icons.git", + "@mdi/svg": "^5.3.45", "@vue/test-utils": "^1.0.0-beta.27", "@vuedoc/parser": "^1.4.0", "babel-jest": "^24.1.0", @@ -51,6 +49,7 @@ "jest": "^24.1.0", "kolibri-tools": "0.13.0-dev.9", "lockr": "^0.8.5", + "material-design-icons": "^3.0.1", "normalize.css": "^8.0.1", "npm-run-all": "^4.1.5", "nuxt": "^2.0.0", @@ -58,6 +57,7 @@ "prismjs": "^1.15.0", "raw-loader": "0.5.1", "sass-loader": "^8.0.2", + "svgo": "^1.3.2", "svg-icon-inline-loader": "^3.1.0", "vue-docgen-api": "^4.15.1", "vue-jest": "^4.0.0-0",