@takuma-ru/vue-library-docs
Status
Description
Documentation library for vue library
DEMO
none
Getting Started
0. Create nuxt-app
npx nuxi@latest init [ directoryName ]
1. Install
yarn add @takuma-ru/vue-library-docs
2. How to use
- Add
@takuma-ru/vue-library-docs
to extends
and use the template.
defineNuxtConfig({
extends: '@takuma-ru/vue-library-docs',
vueLibraryDocs: {
isUsePlugin: true
}
})
- Delete
app.vue
. - Create
app.config.ts
in root.
touch app.config.ts
type nul > app.config.ts
- Edit
app.config.ts
.
import { IAppConfig } from "./types/app.config";
export default defineAppConfig<IAppConfig>({
docs: {
libName: '',
developerName: '',
description: '',
icon: '',
image: '',
repository: '',
npm: '',
supportVersion: {
vue2: true,
vue2Point7: true,
vue3: true,
nuxt2: true,
nuxt3: true
},
socialsAccountName: {
twitter: 'user-name(No need for "@")',
github: '',
facebook: '',
instagram: '',
youtube: '',
medium: ''
},
navigationListSetting: [
{
parentPath: '/playground',
title: 'Playground',
icon: 'slow_motion_video'
}
]
}
})
- Create
content
folder in root.
mkdir content
License
MIT - Copyright (c) 2023 takuma-ru