diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 84c0d8f..844c736 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -8,11 +8,29 @@ export default defineConfig({ lastUpdated: true, themeConfig: { nav: [ - { text: 'Guide', link: '/guide' }, - { text: 'Github', link: 'https://github.com/anatolykopyl/vue-three-d-mockup' } + { text: 'Guide', link: '/guide/' }, + ], + sidebar: [ + { + text: 'Guide', + items: [ + { text: 'Introduction', link: '/guide/' }, + { text: 'Screen from assets', link: '/guide/screen-from-assets' }, + { text: 'Video as screen', link: '/guide/video-as-screen' }, + { text: 'Multiple mockups', link: '/guide/multiple-mockups' }, + { text: 'Theming', link: '/guide/theming' }, + { text: 'Props', link: '/guide/props' }, + ] + } ], footer: { message: 'Released under the GPL-3.0 license.', - } + }, + socialLinks: [ + { + icon: 'github', + link: 'https://github.com/anatolykopyl/vue-three-d-mockup' + } + ] } }) diff --git a/docs/guide.md b/docs/guide.md deleted file mode 100644 index 976ad4d..0000000 --- a/docs/guide.md +++ /dev/null @@ -1,191 +0,0 @@ -# Guide - -## Installation - -```bash -npm install vue-three-d-mockup -``` - -## Usage - - - - - -### Simple example - -`screen.png` is a static asset in the public folder. - -```vue - - - -``` - -### Using assets as the screen - -- #### In vite powered projects - -```vue - - - -``` - -- #### In vue-cli powered projects - -```vue - - - -``` - -### Multiple phones - - - -```vue - - - -``` - -### Video - - - -
- -
- -```vue - - - -``` - -## Avaliable props - -| Prop | Type | Required | Default | Description | -| ---------- | -------------------------- | -------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `screen` | String \| Element \| Array | `true` | none | Path to an image that will be displayed on the phones screen or the `