@redsift/icons 8.0.0-alpha.2 → 8.0.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +3 -3
- package/package.json +2 -2
package/CONTRIBUTING.md
CHANGED
|
@@ -355,9 +355,9 @@ yarn dev:website
|
|
|
355
355
|
|
|
356
356
|
Then, open [http://localhost:3000](http://localhost:3000) in your browser.
|
|
357
357
|
|
|
358
|
-
To add documentation for a component, a MDX file should be created in the `
|
|
358
|
+
To add documentation for a component, a MDX file should be created in the `apps/website/pages/` folder and more precisely inside the subfolder corresponding to the section the page belongs to (i.e. `apps/website/pages/forms/checkbox.mdx` for the `Checkbox` component inside the `Forms` section).
|
|
359
359
|
|
|
360
|
-
To appear in the website's Side Panel, the page should be listed in `
|
|
360
|
+
To appear in the website's Side Panel, the page should be listed in `apps/website/components/CustomAppSidePanel/CustomAppSidePanel.tsx`) under the corresponding section.
|
|
361
361
|
|
|
362
362
|
A component page should be structured as following:
|
|
363
363
|
|
|
@@ -380,7 +380,7 @@ To display a prop table, use the `PropsTable` component as following:
|
|
|
380
380
|
<PropsTable component="Button" />
|
|
381
381
|
```
|
|
382
382
|
|
|
383
|
-
To display a demo, first create a demo (a simple `tsx` file) in the demo folder (`
|
|
383
|
+
To display a demo, first create a demo (a simple `tsx` file) in the demo folder (`apps/website/demo/`) inside a subfolder with the name of the component (i.e. `apps/website/demo/button/coloring` for a coloring demo of the `Button` component). Then use the `DemoBlock` as following:
|
|
384
384
|
|
|
385
385
|
```ts
|
|
386
386
|
<DemoBlock path="button/coloring" />
|
package/package.json
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"url": "git+https://github.com/redsift/design-system"
|
|
20
20
|
},
|
|
21
21
|
"sideEffects": false,
|
|
22
|
-
"version": "8.0.0-alpha.
|
|
22
|
+
"version": "8.0.0-alpha.3",
|
|
23
23
|
"scripts": {
|
|
24
24
|
"build": "rollup -c",
|
|
25
25
|
"prepublishOnly": "yarn build"
|
|
@@ -49,5 +49,5 @@
|
|
|
49
49
|
"rollup-plugin-ts-paths-resolve": "^1.7.1",
|
|
50
50
|
"rollup-plugin-typescript-paths": "^1.3.1"
|
|
51
51
|
},
|
|
52
|
-
"gitHead": "
|
|
52
|
+
"gitHead": "b56ba7f18e7aa4eb518ef321f49a6c562d55d386"
|
|
53
53
|
}
|