Skip to content

Commit 9001695

Browse files
ph1pph1p
committed
refactor: start to rewrite the code
1 parent 413ee2b commit 9001695

File tree

19 files changed

+488
-577
lines changed

19 files changed

+488
-577
lines changed

‎example/documentation/code/README.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎example/documentation/code/components/sub/sub-test.md

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,4 @@
11
---
22
title: sub-test
33
---
4-
# grid
5-
6-
> This is an example of creating a reusable grid component and using it with external data.
7-
8-
Author: [Rafael](https://github.com/rafaesc92)
9-
10-
Since: Version 1.0.1
11-
12-
Version: 1.0.5
13-
14-
## Props
15-
16-
| Prop name | Description | Type | Values | Default |
17-
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------ | --------------------- |
18-
| msg | object/array defaults should be returned from a factory function<br/>`@version` 1.0.5<br/>`@since` Version 1.0.1<br/>`@see` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names<br/>`@link` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names | string\|number | - | text |
19-
| myF | Function | func | - | (param, param2) => {} |
20-
| v-model | Model example<br/>`@model` true | string | - | |
21-
| data | describe data<br/>`@version` 1.0.5 | array | - | |
22-
| columns | get columns list | array | - | |
23-
| filterKey | filter key<br/>`@ignore` true | string | - | 'example' |
24-
25-
## Methods
26-
27-
### sortBy
28-
29-
> Sets the order
30-
31-
#### Params
32-
33-
| Param name | Type | Description |
34-
| ---------- | ------ | ------------ |
35-
| key | string | Key to order |
36-
37-
#### Return
38-
39-
| Type | Description |
40-
| ------ | ----------- |
41-
| string | Test |
42-
43-
## Events
44-
45-
| Event name | Properties | Description |
46-
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------------- |
47-
| success | **example** `object` - the demo example<br>**exampleStr** `string` - the demo example<br>**exampleNum** `number` - the demo example | Success event. |
48-
49-
## Slots
50-
51-
| Name | Description | Bindings |
52-
| ------ | -------------------- | -------- |
53-
| header | Use this slot header | |
54-
| footer | Use this slot footer | |
55-
56-
---
4+
# grid > This is an example of creating a reusable grid component and using it with external data. Author: [Rafael](https://github.com/rafaesc92) Since: Version 1.0.1 Version: 1.0.5 ## Props | Prop name | Description | Type | Values | Default | | ------------- | ----------- | --------- | ----------- | ----------- | | msg | object/array defaults should be returned from a factory function<br/>`@version` 1.0.5<br/>`@since` Version 1.0.1<br/>`@see` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names<br/>`@link` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names | string\|number | - | text || myF | Function | func | - | (param, param2) => {} || v-model | Model example<br/>`@model` true | string | - | || data | describe data<br/>`@version` 1.0.5 | array | - | || columns | get columns list | array | - | || filterKey | filter key<br/>`@ignore` true | string | - | 'example' | ## Methods ### sortBy > Sets the order #### Params | Param name | Type | Description | | ------------- |------------- | -------------| | key | string | Key to order | #### Return | Type | Description | | ------------- | -------------| | string | Test | ## Events | Event name | Properties | Description | | -------------- |--------------- | -------------| | success | **example** `object` - the demo example<br>**exampleStr** `string` - the demo example<br>**exampleNum** `number` - the demo example | Success event. ## Slots | Name | Description | Bindings | | ------------- | ------------ | -------- | | header | Use this slot header | || footer | Use this slot footer | | ---

‎example/documentation/code/components/sub/sub-vue-md.md

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,4 @@
11
---
22
title: sub-vue-md
33
---
4-
# Button
5-
6-
> The only true button.
7-
8-
## Props
9-
10-
| Prop name | Description | Type | Values | Default |
11-
| --------- | ----------------------------------------------------------------- | ------ | -------------------------- | ---------------------------------------------------------------------- |
12-
| color | The color for the button. | string | - | '#333' |
13-
| size | The size of the button | string | `small`, `normal`, `large` | 'normal' |
14-
| onClick | Gets called when the user clicks on the button<br/>`@ignore` true | func | - | event => {<br> console.log('You have clicked me!', event.target);<br>} |
15-
16-
## Slots
17-
18-
| Name | Description | Bindings |
19-
| ------- | ----------------- | -------- |
20-
| default | Content of button | |
21-
22-
---
23-
24-
Use vue live right here too
25-
26-
````markdown
27-
```jsx live
28-
<Button>I’m transparent!</Button>
29-
```
30-
````
31-
32-
```jsx live
33-
<Button>I’m transparent!</Button>
34-
```
35-
36-
To render an example as highlighted source code remove the live modifier
37-
38-
```html
39-
<button>I’m transparent!</button>
40-
```
4+
# Button > The only true button. ## Props | Prop name | Description | Type | Values | Default | | ------------- | ----------- | --------- | ----------- | ----------- | | color | The color for the button. | string | - | '#333' || size | The size of the button | string | `small`, `normal`, `large` | 'normal' || onClick | Gets called when the user clicks on the button<br/>`@ignore` true | func | - | event => {<br> console.log('You have clicked me!', event.target);<br>} | ## Slots | Name | Description | Bindings | | ------------- | ------------ | -------- | | default | Content of button | | ---Use vue live right here too````markdown```jsx live<Button>I’m transparent!</Button>``````````jsx live<Button>I’m transparent!</Button>```To render an example as highlighted source code remove the live modifier```html<Button>I’m transparent!</Button>```

‎example/documentation/code/components/test.md

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,4 @@
11
---
22
title: test
33
---
4-
# grid
5-
6-
> This is an example of creating a reusable grid component and using it with external data.
7-
8-
Author: [Rafael](https://github.com/rafaesc92)
9-
10-
Since: Version 1.0.1
11-
12-
Version: 1.0.5
13-
14-
## Props
15-
16-
| Prop name | Description | Type | Values | Default |
17-
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------ | --------------------- |
18-
| msg | object/array defaults should be returned from a factory function<br/>`@version` 1.0.5<br/>`@since` Version 1.0.1<br/>`@see` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names<br/>`@link` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names | string\|number | - | text |
19-
| myF | Function | func | - | (param, param2) => {} |
20-
| v-model | Model example<br/>`@model` true | string | - | |
21-
| data | describe data<br/>`@version` 1.0.5 | array | - | |
22-
| columns | get columns list | array | - | |
23-
| filterKey | filter key<br/>`@ignore` true | string | - | 'example' |
24-
25-
## Methods
26-
27-
### sortBy
28-
29-
> Sets the order
30-
31-
#### Params
32-
33-
| Param name | Type | Description |
34-
| ---------- | ------ | ------------ |
35-
| key | string | Key to order |
36-
37-
#### Return
38-
39-
| Type | Description |
40-
| ------ | ----------- |
41-
| string | Test |
42-
43-
## Events
44-
45-
| Event name | Properties | Description |
46-
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------------- |
47-
| success | **example** `object` - the demo example<br>**exampleStr** `string` - the demo example<br>**exampleNum** `number` - the demo example | Success event. |
48-
49-
## Slots
50-
51-
| Name | Description | Bindings |
52-
| ------ | -------------------- | -------- |
53-
| header | Use this slot header | |
54-
| footer | Use this slot footer | |
55-
56-
---
4+
# grid > This is an example of creating a reusable grid component and using it with external data. Author: [Rafael](https://github.com/rafaesc92) Since: Version 1.0.1 Version: 1.0.5 ## Props | Prop name | Description | Type | Values | Default | | ------------- | ----------- | --------- | ----------- | ----------- | | msg | object/array defaults should be returned from a factory function<br/>`@version` 1.0.5<br/>`@since` Version 1.0.1<br/>`@see` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names<br/>`@link` See [Wikipedia](https://en.wikipedia.org/wiki/Web_colors#HTML_color_names) for a list of color names | string\|number | - | text || myF | Function | func | - | (param, param2) => {} || v-model | Model example<br/>`@model` true | string | - | || data | describe data<br/>`@version` 1.0.5 | array | - | || columns | get columns list | array | - | || filterKey | filter key<br/>`@ignore` true | string | - | 'example' | ## Methods ### sortBy > Sets the order #### Params | Param name | Type | Description | | ------------- |------------- | -------------| | key | string | Key to order | #### Return | Type | Description | | ------------- | -------------| | string | Test | ## Events | Event name | Properties | Description | | -------------- |--------------- | -------------| | success | **example** `object` - the demo example<br>**exampleStr** `string` - the demo example<br>**exampleNum** `number` - the demo example | Success event. ## Slots | Name | Description | Bindings | | ------------- | ------------ | -------- | | header | Use this slot header | || footer | Use this slot footer | | ---

‎example/documentation/code/components/vue-md.md

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,4 @@
11
---
22
title: vue-md
33
---
4-
# Button
5-
6-
> The only true button.
7-
8-
## Props
9-
10-
| Prop name | Description | Type | Values | Default |
11-
| --------- | ----------------------------------------------------------------- | ------ | -------------------------- | ---------------------------------------------------------------------- |
12-
| color | The color for the button. | string | - | '#333' |
13-
| size | The size of the button | string | `small`, `normal`, `large` | 'normal' |
14-
| onClick | Gets called when the user clicks on the button<br/>`@ignore` true | func | - | event => {<br> console.log('You have clicked me!', event.target);<br>} |
15-
16-
## Slots
17-
18-
| Name | Description | Bindings |
19-
| ------- | ----------------- | -------- |
20-
| default | Content of button | |
21-
22-
---
23-
24-
Use vue live right here too
25-
26-
````markdown
27-
```jsx live
28-
<Button>I’m transparent!</Button>
29-
```
30-
````
31-
32-
```jsx live
33-
<Button>I’m transparent!</Button>
34-
```
35-
36-
To render an example as highlighted source code remove the live modifier
37-
38-
```html
39-
<button>I’m transparent!</button>
40-
```
4+
# Button > The only true button. ## Props | Prop name | Description | Type | Values | Default | | ------------- | ----------- | --------- | ----------- | ----------- | | color | The color for the button. | string | - | '#333' || size | The size of the button | string | `small`, `normal`, `large` | 'normal' || onClick | Gets called when the user clicks on the button<br/>`@ignore` true | func | - | event => {<br> console.log('You have clicked me!', event.target);<br>} | ## Slots | Name | Description | Bindings | | ------------- | ------------ | -------- | | default | Content of button | | ---Use vue live right here too````markdown```jsx live<Button>I’m transparent!</Button>``````````jsx live<Button>I’m transparent!</Button>```To render an example as highlighted source code remove the live modifier```html<Button>I’m transparent!</Button>```

‎example/documentation/code/config.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎example/documentation/code/error.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: error
3+
---
4+
5+
# error
6+

‎example/documentation/code/lib/cli-data.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: cli-data
3+
---
4+
5+
# cli-data
6+

‎example/documentation/code/lib/jsdoc-options.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: jsdoc-options
3+
---
4+
5+
# jsdoc-options
6+

0 commit comments

Comments
 (0)