From 8cbef084daeed8fb8f0909083daf8c353a398ce6 Mon Sep 17 00:00:00 2001 From: HoshinoSuzumi Date: Wed, 20 Nov 2024 04:34:31 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20installation=20guide?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../1.getting-started/2.installation.md | 32 ++++++++++++++++++- docs/content/2.components/button.md | 6 ---- docs/nuxt.config.ts | 2 +- docs/pages/[...slug].vue | 4 +-- 4 files changed, 34 insertions(+), 10 deletions(-) diff --git a/docs/content/1.getting-started/2.installation.md b/docs/content/1.getting-started/2.installation.md index 802ac1f..f48c436 100644 --- a/docs/content/1.getting-started/2.installation.md +++ b/docs/content/1.getting-started/2.installation.md @@ -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* diff --git a/docs/content/2.components/button.md b/docs/content/2.components/button.md index bcc12d1..75725a5 100644 --- a/docs/content/2.components/button.md +++ b/docs/content/2.components/button.md @@ -29,9 +29,3 @@ props: --- Button :: - -```js [file.js]{4-6,7} meta-info=val -export default () => { - console.log('Code block') -} -``` diff --git a/docs/nuxt.config.ts b/docs/nuxt.config.ts index df9443c..a4f9d1b 100644 --- a/docs/nuxt.config.ts +++ b/docs/nuxt.config.ts @@ -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: { diff --git a/docs/pages/[...slug].vue b/docs/pages/[...slug].vue index fb66db8..899f9bc 100644 --- a/docs/pages/[...slug].vue +++ b/docs/pages/[...slug].vue @@ -70,7 +70,7 @@ const { data: surround } = await useAsyncData(`${route.path}-surround`, () => {
Previous {{ surround[0].title }} - {{ surround[0].description }} + {{ surround[0].description }}
@@ -79,7 +79,7 @@ const { data: surround } = await useAsyncData(`${route.path}-surround`, () => {
Next {{ surround[1].title }} - {{ surround[1].description }} + {{ surround[1].description }}