Skip to content

Commit 2f4694c

Browse files
jonasjabarigitbook-bot
authored andcommitted
GitBook: [#7] No subject
1 parent 88aabdf commit 2f4694c

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/getting-started/installation-update.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ gem 'matestack-ui-vuejs'
1414

1515
and run
1616

17-
```text
17+
```
1818
$ bundle install
1919
```
2020

2121
### Matestack Ui Core install steps (if not already happened)
2222

2323
Create a folder called 'matestack' in your app directory. All your Matestack apps, pages and components will be defined there.
2424

25-
```text
25+
```
2626
$ mkdir app/matestack
2727
```
2828

@@ -45,16 +45,16 @@ will be shipped in `matestack-ui-vuejs` `3.1`
4545

4646
Add 'matestack-ui-vuejs' to your `package.json` by running:
4747

48-
```text
48+
```
4949
$ yarn add matestack-ui-vuejs
5050
```
5151

5252
This adds the npm package that provides the JavaScript corresponding to the matestack-ui-vuejs Ruby gem. Make sure that the npm package version matches the gem version. To find out what gem version you are using, you may use `bundle info matestack-ui-vuejs`.
5353

5454
**Note**:
5555

56-
- vue3 dropped IE 11 support
57-
- when using babel alongside webpacker, please adjust your package.json or .browserslistrc config in order to exclude IE 11 support:
56+
* vue3 dropped IE 11 support
57+
* when using babel alongside webpacker, please adjust your package.json or .browserslistrc config in order to exclude IE 11 support:
5858

5959
```json
6060
{
@@ -85,7 +85,8 @@ document.addEventListener('DOMContentLoaded', () => {
8585
and properly configure webpack:
8686

8787
`config/webpack/environment.js`
88-
```js
88+
89+
```javascript
8990
const { environment } = require('@rails/webpacker')
9091
const webpack = require('webpack');
9192

@@ -110,10 +111,9 @@ module.exports = environment
110111

111112
(don't forget to restart webpacker when changing this file!)
112113

113-
114114
and then finally compile the JavaScript code with webpack:
115115

116-
```text
116+
```
117117
$ bin/webpack --watch
118118
```
119119

@@ -144,12 +144,11 @@ appInstance.use(TurbolinksAdapter); // tell Vue to use it
144144
document.addEventListener('turbolinks:load', () => {
145145
MatestackUiVueJs.mount(appInstance)
146146
})
147-
148147
```
149148

150149
### Application layout adjustments
151150

152-
You need to add the ID "matestack-ui" to some part of your application layout \(or any layout you use\). That's required for Matestack's Vue.js to work properly!
151+
You need to add the ID "matestack-ui" to some part of your application layout (or any layout you use). That's required for Matestack's Vue.js to work properly!
153152

154153
For Example, your `app/views/layouts/application.html.erb` should look like this:
155154

@@ -186,7 +185,9 @@ Don't apply the "matestack-ui" id to the body tag.
186185

187186
Some of Matestack's reactive components may be used with or require ActionCable. If you want to use ActionCable, please read the action cable guide:
188187

189-
{% page-ref page="../integrations/action-cable.md" %}
188+
{% content-ref url="../integrations/action-cable.md" %}
189+
[action-cable.md](../integrations/action-cable.md)
190+
{% endcontent-ref %}
190191

191192
## Update
192193

0 commit comments

Comments
 (0)