@muenchen/muc-patternlab-vue 1.0.1-beta.6 → 1.0.1-beta.8
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/README.md +8 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,36 +20,12 @@ See the [open issues](#) for a full list of proposed features (and known issues)
|
|
|
20
20
|
|
|
21
21
|
## Usage
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
```shell
|
|
26
|
-
npm i @muenchen/muc-patternlab-vue
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
Required Peer Dependencies:
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
"vue": "^3.4.0"
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### Use
|
|
36
|
-
|
|
37
|
-
e.G. Using the MucBanner-Component:
|
|
38
|
-
|
|
39
|
-
```vue
|
|
40
|
-
<script setup>
|
|
41
|
-
import { MucBanner } from "@muenchen/muc-patternlab-vue";
|
|
42
|
-
</script>
|
|
43
|
-
|
|
44
|
-
<template>
|
|
45
|
-
<muc-banner title="Hello Muc">
|
|
46
|
-
<div>How are you?</div>
|
|
47
|
-
</muc-banner>
|
|
48
|
-
</template>
|
|
49
|
-
```
|
|
23
|
+
Please refer to the [documentation](docs/guide/index.md).
|
|
50
24
|
|
|
51
25
|
## Develop
|
|
52
26
|
|
|
27
|
+
### Setup
|
|
28
|
+
|
|
53
29
|
```shell
|
|
54
30
|
git clone https://github.com/it-at-m/muc-patternlab-vue.git
|
|
55
31
|
cd muc-patternlab-vue
|
|
@@ -57,8 +33,6 @@ npm install
|
|
|
57
33
|
npm run docs:dev
|
|
58
34
|
```
|
|
59
35
|
|
|
60
|
-
## Documentation
|
|
61
|
-
|
|
62
36
|
### Release and Publish
|
|
63
37
|
|
|
64
38
|
This project uses [semantic-release](https://github.com/semantic-release/semantic-release)!
|
|
@@ -76,8 +50,12 @@ It follows [Angulars Commit Message Conventions](https://github.com/angular/angu
|
|
|
76
50
|
1. Create a new Folder under `./src/components`-Directory
|
|
77
51
|
2. Create Vue-Component (with composition api) and index.ts-File which exports your component
|
|
78
52
|
3. Add your new Component to `./src/components/index.ts`
|
|
53
|
+
4. Create documentation for your component
|
|
54
|
+
1. Create at least one "Basic" demo at `./docs/components/demo/<your-component>`
|
|
55
|
+
2. Create a doc-File for your component at `./docs/components/<your-component>.md`
|
|
56
|
+
3. Add your component doc to the sidebar at `./docs/.vitepress/config.ts`
|
|
79
57
|
|
|
80
|
-
### Using
|
|
58
|
+
### Using MDE5 Patternlab-Icons
|
|
81
59
|
|
|
82
60
|
Patternlab-Icons are provided by a svg-Sprite which is automatically injected in this repos App.vue-File for local testing. You can expect the users of this library to do the same thing.
|
|
83
61
|
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"author": "FabianWilms",
|
|
4
4
|
"description": "A vue component library of some of the components available from https://patternlab.muenchen.space",
|
|
5
5
|
"license": "MIT",
|
|
6
|
-
"version": "1.0.1-beta.
|
|
6
|
+
"version": "1.0.1-beta.8",
|
|
7
7
|
"private": false,
|
|
8
8
|
"module": "./dist/muc-patternlab-vue.es.js",
|
|
9
9
|
"types": "./dist/types/index.d.ts",
|