Skip to content

Commit 61461f2

Browse files
jonasjabarijonasjabari
committed
Merge branch 'main' of github.com:matestack/matestack-ui-bootstrap into main
2 parents bac5c65 + 7524478 commit 61461f2

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

‎docs/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,17 @@ description: Matestack Ui Bootstrap - Beautiful, reactive web UIs, Ruby and you!
55
# Welcome
66

77
{% hint style="info" %}
8-
You're reading the docs for 3.0 which are WIP currently. Switch to 2.1 on the left to read the docs for 2.1
8+
Version 3 was released on in February 2022. Click here for more [details](migrate-from-2.x-to-3.0.md)
9+
10+
**Most important changes:**
11+
12+
* Split `matestack-ui-core` into `matestack-ui-core` and `matestack-ui-vuejs`
13+
* Rails 7 support
14+
* Vue 3 support in `matestack-ui-vuejs`
15+
16+
****
17+
18+
You're reading the docs for 3.0 --> If you want to see the docs for Version 2.1, click [here](https://docs.matestack.io/matestack-ui-bootstrap/v/2.1/)
919
{% endhint %}
1020

1121
`matestack-ui-bootstrap` ships all you need to build **reactive AND styled** UIs in **pure Ruby** orchestrating styled components (based on Bootstrap v5) with a simple Ruby DSL. Additionally smart CRUD components helps you building beautiful data-driven admin and application UIs.
@@ -20,7 +30,7 @@ All features of `matestack-ui-core` and `matestack-ui-vuejs` can be mixed in whi
2030

2131
* Rails 7.0.1 + Ruby 3.0.0 + Vue.js 3.2.26
2232
* Rails 6.1.1 + Ruby 3.0.0 + Vue.js 3.2.26
23-
* Rails 6.1.1 + Ruby 2.7.2 + Vue.js 3.2.26  
33+
* Rails 6.1.1 + Ruby 2.7.2 + Vue.js 3.2.26
2434
* Rails 6.0.3.4 + Ruby 2.6.6 + Vue.js 3.2.26
2535
* Rails 5.2.4.4 + Ruby 2.6.6 + Vue.js 3.2.26
2636

@@ -44,7 +54,7 @@ You might want to have a look at the dummy app in oder to better understand what
4454

4555
Alongside smart components, `matestack-ui-boostrap` ships all Bootstrap v5 components enabling you to use them in pure Ruby.
4656

47-
Imagine adding a Bootstrap \`card\` component within one line of Ruby, skipping recreating the required DOM structures again and again? 
57+
Imagine adding a Bootstrap \`card\` component within one line of Ruby, skipping recreating the required DOM structures again and again?
4858

4959
```ruby
5060
bs_card title: "foo", body: "bar" #bs_card is shipped within matestack-ui-bootstrap
@@ -101,7 +111,6 @@ class MyAdmin::Pages::Customer::Index < Matestack::Ui::Page
101111
end
102112

103113
end
104-
105114
```
106115

107116
#### Flexible, responsive, prebuilt app layouts
@@ -465,7 +474,6 @@ class MyAdmin::Pages::Products::Index < Matestack::Ui::Page
465474

466475

467476
end
468-
469477
```
470478

471479
which then looks like this -->

‎docs/getting-started/installation-update.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44

55
Make sure to install and get to know `matestack-ui-core` and `matestack-ui-vuejs` first!
66

7-
- [https://docs.matestack.io/matestack-ui-core](https://docs.matestack.io/matestack-ui-core)
8-
- [https://docs.matestack.io/matestack-ui-vuejs](https://docs.matestack.io/matestack-ui-vuejs)
9-
10-
## Installation
7+
* [https://docs.matestack.io/matestack-ui-core](https://docs.matestack.io/matestack-ui-core)
8+
* [https://docs.matestack.io/matestack-ui-vuejs](https://docs.matestack.io/matestack-ui-vuejs)
119

1210
Add 'matestack-ui-bootstrap' to your Gemfile
1311

@@ -56,9 +54,6 @@ For Example, your `app/views/layouts/application.html.erb` should look like this
5654
5755
<!-- if you are using webpacker: -->
5856
<%= javascript_pack_tag 'application' %>
59-
60-
<!-- if you are using the asset pipeline: -->
61-
<%= javascript_include_tag 'application' %>
6257
</head>
6358
6459
<body>
@@ -81,10 +76,16 @@ will be shipped in `matestack-ui-bootstrap` `3.1`
8176

8277
#### Webpacker > 5.x based JavaScript installation
8378

84-
Add 'matestack-ui-vuejs' to your `package.json` by running:
79+
Add 'matestack-ui-vuejs' to your `package.json` by adding:
8580

8681
```
87-
$ yarn add matestack-ui-bootstrap@3.0.0-rc1
82+
{
83+
"name": "my-app",
84+
"dependencies": {
85+
"matestack-ui-bootstrap": "^3.0.0-rc1",
86+
"..."
87+
}
88+
}
8889
```
8990

9091
This adds the npm package that provides the JavaScript corresponding to the matestack-ui-bootstrap 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-bootstrap`.
@@ -199,11 +200,11 @@ Download and import Bootstraps icons:
199200
`app/assets/images/icons`
200201

201202
* download latest compatible icons: [https://github.com/twbs/icons/releases/tag/v1.8.1](https://github.com/twbs/icons/releases/tag/v1.8.1)
202-
* extract the bootstrap-icons.svg to this path: app/assets/images/icons \(currently served via assets pipeline, we had issues serving the icons via Webpack\)
203+
* extract the bootstrap-icons.svg to this path: app/assets/images/icons (currently served via assets pipeline, we had issues serving the icons via Webpack)
203204

204205
and finally compile the code with webpack:
205206

206-
```text
207+
```
207208
$ bin/webpack --watch
208209
```
209210

0 commit comments

Comments
 (0)