takuma-ru / vue-library-docs

Documentation template library for vue library

@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

1. Add @takuma-ru/vue-library-docs to extends and use the template.

   defineNuxtConfig({
     extends: '@takuma-ru/vue-library-docs',
     vueLibraryDocs: {
       isUsePlugin: true // Flag whether to use `@takuma-ru/vue-library-docs` templates and components.
     }
   })

2. Delete app.vue.
3. Create app.config.ts in root.

   touch app.config.ts

   type nul > app.config.ts

4. Edit app.config.ts.

   export default defineAppConfig({
     docs: {
       libName: '',
       developerName: '',
       description: '',
       icon: '',
       image: '',
       repository: '',
       npm: '',
       supportVersion: {
         vue2: true,
         vue2Point7: true,
         vue3: true,
         nuxt2: true,
         nuxt3: true
       },
       socialsAccountName: {
         twitter: '',
         github: '',
         facebook: '',
         instagram: '',
         youtube: '',
         medium: ''
       },
     }
   })

5. Create content folder in root.

   mkdir content

License

MIT - Copyright (c) 2023 takuma-ru