Skip to content

Commit

Permalink
refactor: start to rewrite the code
Browse files Browse the repository at this point in the history
  • Loading branch information
@ph1p
ph1p committed Aug 31, 2021
1 parent 413ee2b commit 9001695
Show file tree
Hide file tree
Showing 19 changed files with 488 additions and 577 deletions.
9 changes: 0 additions & 9 deletions example/documentation/code/README.md
View file

This file was deleted.

54 changes: 1 addition & 53 deletions example/documentation/code/components/sub/sub-test.md
View file
Original file line number Diff line number Diff line change
@@ -1,56 +1,4 @@
---
title: sub-test
---
# 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 | |

---
# 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 | | ---
38 changes: 1 addition & 37 deletions example/documentation/code/components/sub/sub-vue-md.md
View file
Original file line number Diff line number Diff line change
@@ -1,40 +1,4 @@
---
title: sub-vue-md
---
# 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>
```
# 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>```
54 changes: 1 addition & 53 deletions example/documentation/code/components/test.md
View file
Original file line number Diff line number Diff line change
@@ -1,56 +1,4 @@
---
title: test
---
# 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 | |

---
# 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 | | ---
38 changes: 1 addition & 37 deletions example/documentation/code/components/vue-md.md
View file
Original file line number Diff line number Diff line change
@@ -1,40 +1,4 @@
---
title: vue-md
---
# 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>
```
# 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>```
1 change: 0 additions & 1 deletion example/documentation/code/config.js
View file

This file was deleted.

6 changes: 6 additions & 0 deletions example/documentation/code/error.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: error
---

# error

6 changes: 6 additions & 0 deletions example/documentation/code/lib/cli-data.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: cli-data
---

# cli-data

6 changes: 6 additions & 0 deletions example/documentation/code/lib/jsdoc-options.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: jsdoc-options
---

# jsdoc-options

Loading

0 comments on commit 9001695

Please sign in to comment.