Merge pull request #56 from GlobalHive/feat-rewrite

Feat rewrite

Author: GlobalHive

.github/workflows/docs.yml

@@ -20,6 +20,6 @@ jobs:
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@v4
         with:
-          folder: docs/.vuepress/dist/
+          folder: docs/.vitepress/dist/
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/npm-publish.yml

@@ -28,4 +28,4 @@ jobs:
       - name: Publish
         run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/release-please.yml

@@ -14,4 +14,4 @@ jobs:
     steps:
       - uses: google-github-actions/release-please-action@v3
         with:
-          release-type: node
+          release-type: node

.gitignore

@@ -24,3 +24,7 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+
+# Vitepress
+docs/.vitepress/dist
+docs/.vitepress/cache

CHANGELOG.md

@@ -198,4 +198,4 @@
 
 * **docs:** Fixed missing package error ([5994f85](https://github.com/GlobalHive/vuejs-tour/commit/5994f8528a5d95f318d29a99d76d0c4936a5c5dd))
 * **package:** fixed formatting ([50eba1c](https://github.com/GlobalHive/vuejs-tour/commit/50eba1c5ed4c55d1a9bfd470071299bc6e8c6328))
-* **package:** Fixed pop up showing before start ([6d1feaa](https://github.com/GlobalHive/vuejs-tour/commit/6d1feaab5e0ae90bb1b9863cf8c307501387e1fc))
+* **package:** Fixed pop up showing before start ([6d1feaa](https://github.com/GlobalHive/vuejs-tour/commit/6d1feaab5e0ae90bb1b9863cf8c307501387e1fc))

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -143,4 +143,4 @@ For more information about the available props and methods, check out the [docum
 
 ## Something Missing?
 
-If you have a feature request or found a bug, [let us know](https://github.com/GlobalHive/vuejs-tour/issues) by submitting an issue.
+If you have a feature request or found a bug, [let us know](https://github.com/GlobalHive/vuejs-tour/issues) by submitting an issue.

docs/.vitepress/config.ts

@@ -0,0 +1,82 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: "VueJS Tour",
+  description: "Guide your users through your application quickly and easily.",
+  lang: 'en-US',
+  themeConfig: {
+    logo: 'https://vuejs.org/images/logo.png',
+    nav: [
+      { text: 'Guide', link: '/guide/what-is-vuejs-tour' },
+      { text: 'Reference', link: '/reference/coming-soon' },
+      { text: '1.2.3', items: [
+        { text: 'Changelog', link: 'https://github.com/GlobalHive/vuejs-tour/blob/master/CHANGELOG.md' },
+        { text: 'Roadmap', link: '/guide/roadmap' },
+        { text: 'Issues', link: 'https://github.com/GlobalHive/vuejs-tour/issues' }]
+      }
+    ],
+    sidebar: {
+      '/guide/': [
+        {
+          text: 'Introduction',
+          collapsed: false,
+          items: [
+              { text: 'What is VueJS Tour?', link: '/guide/what-is-vuejs-tour' },
+              { text: 'Getting Started', link: '/guide/getting-started' },
+              { text: 'Create a Tour', link: '/guide/create-a-tour' },
+          ]
+        },
+        {
+          text: 'Customization',
+          collapsed: false,
+          items: [
+            { text: 'Start Options', link: '/guide/start-options' },
+            { text: 'Highlight Target', link: '/guide/highlight-target' },
+            { text: 'Using a Backdrop', link: '/guide/using-a-backdrop' },
+            { text: 'Hiding the Arrow', link: '/guide/hiding-the-arrow' },
+            { text: 'Tour Margin', link: '/guide/tour-margin' },
+            { text: 'Saving Progress', link: '/guide/saving-progress' },
+          ]
+        },
+        {
+          text: 'Advanced',
+          collapsed: false,
+          items: [
+            { text: 'Skipping a Tour', link: '/guide/skipping-a-tour' },
+            { text: 'Button Labels', link: '/guide/button-labels' },
+            { text: 'Step Options', link: '/guide/step-options' },
+            { text: 'Multiple Tours', link: '/guide/multiple-tours' },
+          ]
+        },
+        {
+          text: "What's next?",
+          collapsed: false,
+          items: [
+            { text: 'Roadmap', link: '/guide/roadmap' },
+            { text: 'Changelog', link: 'https://github.com/GlobalHive/vuejs-tour/blob/master/CHANGELOG.md' },
+          ]
+        }
+      ],
+      '/reference/': [
+        {
+          text: 'Reference',
+          collapsed: false,
+          items: [
+            { text: 'Coming Soon', link: '/reference/coming-soon' },
+          ]
+        },
+      ],
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/GlobalHive/vuejs-tour' }
+    ],
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Made with ❤️ by Global Hive'
+    },
+    editLink: {
+      pattern: 'https://github.com/GlobalHive/vuejs-tour/tree/master/docs/:path',
+      text: 'Edit this page on GitHub'
+    },
+  }
+})