Skip to content

Commit

Permalink
fix(app): github component links
Browse files Browse the repository at this point in the history
This pull request is intended to fix the github component links
  • Loading branch information
Selemondev authored and Selemondev committed Aug 9, 2023
1 parent 420a0ad commit 4f528e5
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 14 deletions.
4 changes: 2 additions & 2 deletions docs/docs/.vitepress/components/demo-block/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { ExtractPropTypes } from 'vue'
export const demoProps = {
github: {
type: String,
default: 'https://github.com/onu-ui/onu-ui',
default: 'https://github.com/selemondev/windi-ui',
},
codeSandBox: {
type: String,
Expand Down Expand Up @@ -35,4 +35,4 @@ export const demoProps = {
},
} as const

export type ODemoProps = ExtractPropTypes<typeof demoProps>
export type DemoProps = ExtractPropTypes<typeof demoProps>
2 changes: 2 additions & 0 deletions docs/docs/.vitepress/components/demo-block/src/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { demoProps } from './index'
const props = defineProps(demoProps)
const github = 'https://github.com/selemondev/windi-ui'
const decodedHighlightedCode = computed(() =>
decodeURIComponent(props.highlightedCode),
)
Expand Down
12 changes: 6 additions & 6 deletions docs/docs/guide/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installation

Add `Windi UI` to your project by running one of the following commands:
Adding `Windi UI` to your project is relatively straightforward. Run one of the following commands in your terminal to get started:

::: code-group
```bash [pnpm]
Expand Down Expand Up @@ -34,11 +34,11 @@ module.exports = {

### Component registration

- With Windi UI, you have the flexibility to register components precisely as you wish:
With Windi UI, you have the flexibility to register components precisely as you wish:

### Import All Components

- To import all the components provided by `Windi UI`, add `WindiUI` in your main entry file as shown below:
To import all the components provided by `Windi UI`, add `WindiUI` in your main entry file as shown below:

```ts
import { createApp } from 'vue'
Expand Down Expand Up @@ -104,11 +104,11 @@ The `prefix` option is only available for individual component imports.

### Auto Imports with Tree Shaking

- **Windi UI** comes with an intelligent resolver that automatically imports only used components.
**Windi UI** comes with an intelligent resolver that automatically imports only used components.

- This is made possible by leveraging a tool known as [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) which lets you auto import components on demand thus omitting import statements and still get the benefits of tree shaking.
This is made possible by leveraging a tool known as [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) which lets you auto import components on demand thus omitting import statements and still get the benefits of tree shaking.

- To achieve this you need to do the following:
To achieve this you need to do the following:

1. Install the `unplugin-vue-components` package by running one of the following commands:

Expand Down
4 changes: 4 additions & 0 deletions playground/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

![site-screenshot](./public/windi-ui-playground.png)

## 🚧 WIP

The Windi UI playground is in active development at the moment.


## Comes with:

Expand Down
2 changes: 0 additions & 2 deletions playground/src/components/Header.vue
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<script setup lang="ts">
// import { OMessage as message } from 'onu-ui'
import type { ComputedRef } from 'vue'
import Logo from "../public/windi.png";
import { Icon } from "@iconify/vue";
// import type { OMessageProps } from 'onu-ui'
import playConfig from '../../playground.config'
import { getSupportVersions } from '~/utils/versions'
import type { ReplStore, VersionKey } from '~/composables/store'
Expand Down
1 change: 0 additions & 1 deletion playground/src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import App from './App.vue'
import '@vue/repl/dist/style.css'
import "./assets/tailwind.css"
import '@unocss/reset/tailwind.css'
// import 'onu-ui/dist/style.css'
import 'uno.css'

// @ts-expect-error Custom window property
Expand Down
1 change: 0 additions & 1 deletion playground/src/template/lib-install.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { getCurrentInstance } from 'vue'
// import UnoUI from 'onu-ui'
// import install from '@selemondev/windi-ui'

let installed = false
Expand Down
1 change: 0 additions & 1 deletion playground/unocss.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import {
transformerDirectives,
transformerVariantGroup,
} from 'unocss'
// import { presetOnu } from 'onu-ui'

export default defineConfig({
presets: [
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"jsx": "preserve",
"types": ["node", "vite/client"],
"paths": {
"windi-ui": ["./packages/onu-ui/src/index.ts"],
"windi-ui": ["./packages/windi-ui/src/index.ts"],
"@windi-ui/docs": ["./docs/*"]
}
},
Expand Down

0 comments on commit 4f528e5

Please sign in to comment.