You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 1, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ For the most control over your CSS, it's highly recommended to integrate the SCS
55
55
56
56
You can then easily customize `_config.scss` with your intended brand attributes. This is where you'd also define a scope to isolate Undernet styles.
57
57
58
-
For more details on the config, check out the [Getting Started](https://undernet.io/docs/getting-started) page.
58
+
For more details on customizing branding, check out the [Branding](https://undernet.io/docs/overview/branding) page.
59
59
60
60
### NPM / JS modules
61
61
@@ -65,7 +65,7 @@ Another option is to use the npm package and borrow the modules you need. This i
65
65
$ npm install --save-dev undernet
66
66
```
67
67
68
-
Check out the [docs](https://undernet.io/docs/overview) to see the necessary DOM structure for a given component.
68
+
Check out the [documentation](https://undernet.io/docs/overview/javascript) to see the necessary DOM structure for a given component.
69
69
70
70
Then require or import the dependency in your js, or add it to a script tag in your main layout (see the **Easy setup** method above for script usage).
71
71
@@ -76,13 +76,13 @@ import Undernet from "undernet"
76
76
Undernet.start()
77
77
78
78
// or only use a single component, e.g. the Modal:
79
-
// NOTE: if you use Undernet.start(), you're effectively doing nothing with this method call
79
+
// NOTE: if you use Undernet.start(), you're effectively doing nothing with this property call
80
80
Undernet.Modals.start()
81
81
```
82
82
83
83
#### React
84
84
85
-
Undernet fully supports use in React. You simply need to call the `.start()`method in `componentDidMount()`, and then `.stop()` in `componentWillUnmount()` (to prevent unnecessary event listeners when the components are no longer visible):
85
+
Undernet fully supports use in React. You simply need to call the `.start()`property in `componentDidMount()`, and then `.stop()` in `componentWillUnmount()` (to prevent unnecessary event listeners when the components are no longer visible):
@@ -167,11 +167,10 @@ Then globally install `sass` and `rollup`:
167
167
168
168
```shell
169
169
$ gem install sass
170
-
$ npm install -g rollup
171
170
$ npm run build:development
172
171
```
173
172
174
-
From there, everything should build correctly: the framework scss and js will be prettified by `prettier` and distributions of js and css will be output using `babel-cli`, `rollup`, `sass`, and a few macOS specific commands for zipping/prepping files for release. The output typically takes 5-10 seconds at most.
173
+
From there, everything should build correctly: the framework scss and js will be prettified by `prettier` and distributions of js and css will be output using `@babel`, `rollup`, `sass`, and a few macOS specific commands for zipping/prepping files for release. The output typically takes 5-10 seconds at most.
0 commit comments