Skip to content

Commit c63bf15

Browse files
authored
Merge pull request #1332 from undp/1331-update-patching-workflow-to-apply-only-to-windows-environments
#1331 - decoupled patching to the separate command and updated docume…
2 parents c022212 + cd44aa2 commit c63bf15

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Living Style Guide & Documentation: **[Demo](https://design.undp.org)**
2020
npm install @undp/design-system
2121
```
2222
See Starter project at the link below for details of implementaiton
23+
2324
## Starter project
2425

2526
Static generator using Design System as dependency: [UNDP Design System starter template](https://github.com/undp/design-system-starter-template)
@@ -35,6 +36,10 @@ git clone
3536
# install project dependencies
3637
npm install
3738

39+
# In Windows environment apply patch to the mdx1-csf plugin.
40+
# This can be omitted when this PR is merged: https://github.com/storybookjs/mdx1-csf/pull/27
41+
npm run windows-patch-package
42+
3843
# runs storybook locally
3944
npm run storybook
4045

@@ -43,10 +48,6 @@ npm run build-storybook
4348

4449
# build compiled css and js
4550
npm run build
46-
47-
# linting on codebase
48-
# caution: this will write changes to your files
49-
npm run lint
5051
```
5152

5253
### Important

package-lock.json

+5-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"build": "webpack --progress",
1010
"storybook": "storybook dev -p 6006",
1111
"build-storybook": "storybook build --loglevel verbose",
12-
"postinstall": "patch-package"
12+
"windows-patch-package": "patch-package"
1313
},
1414
"keywords": [
1515
"UNDP",

0 commit comments

Comments
 (0)