mirror of
https://github.com/HoshinoSuzumi/rayine-ui.git
synced 2025-04-07 11:38:50 +08:00
📝 docs: installation guide
This commit is contained in:
parent
a7d52de649
commit
8cbef084da
@ -1 +1,31 @@
|
||||
## TODO
|
||||
## Setup
|
||||
|
||||
1. Install rayine-ui via npm or other package manager.
|
||||
|
||||
```bash
|
||||
npm install rayine-ui
|
||||
```
|
||||
|
||||
or...
|
||||
|
||||
```bash
|
||||
npx nuxi@latest module add rayine-ui
|
||||
```
|
||||
|
||||
2. Add to the modules in your project.
|
||||
|
||||
```ts
|
||||
export default defineNuxtConfig({
|
||||
modules: ['rayine-ui']
|
||||
})
|
||||
```
|
||||
|
||||
Now you can use the components in your project.
|
||||
|
||||
## TypeScript
|
||||
|
||||
*TBD*
|
||||
|
||||
## Options
|
||||
|
||||
*TBD*
|
||||
|
@ -29,9 +29,3 @@ props:
|
||||
---
|
||||
Button
|
||||
::
|
||||
|
||||
```js [file.js]{4-6,7} meta-info=val
|
||||
export default () => {
|
||||
console.log('Code block')
|
||||
}
|
||||
```
|
||||
|
@ -31,7 +31,7 @@ export default defineNuxtConfig({
|
||||
},
|
||||
content: {
|
||||
highlight: {
|
||||
langs: ["postcss", "mdc", "html", "vue", "ts", "js"],
|
||||
langs: ["postcss", "mdc", "html", "vue", "ts", "js", "bash"],
|
||||
},
|
||||
},
|
||||
mdc: {
|
||||
|
@ -70,7 +70,7 @@ const { data: surround } = await useAsyncData(`${route.path}-surround`, () => {
|
||||
<div>
|
||||
<span class="tip">Previous</span>
|
||||
<span class="title">{{ surround[0].title }}</span>
|
||||
<span class="description">{{ surround[0].description }}</span>
|
||||
<span class="description" v-if="surround[0].description">{{ surround[0].description }}</span>
|
||||
</div>
|
||||
</NuxtLink>
|
||||
</div>
|
||||
@ -79,7 +79,7 @@ const { data: surround } = await useAsyncData(`${route.path}-surround`, () => {
|
||||
<div>
|
||||
<span class="tip">Next</span>
|
||||
<span class="title">{{ surround[1].title }}</span>
|
||||
<span class="description">{{ surround[1].description }}</span>
|
||||
<span class="description" v-if="surround[1].description">{{ surround[1].description }}</span>
|
||||
</div>
|
||||
</NuxtLink>
|
||||
</div>
|
||||
|
Loading…
Reference in New Issue
Block a user