Skip to content

Commit b8c5764

Browse files
authored
Merge pull request #98 from AdamDrewsTR/minor-cleanup
Fix doc builds, Etc
2 parents d3521ba + 379e160 commit b8c5764

11 files changed

Lines changed: 1568 additions & 868 deletions

File tree

.github/workflows/ci.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313

1414
strategy:
1515
matrix:
16-
node-version: [18, 20, 22]
16+
node-version: [20, 22]
1717

1818
steps:
1919
- name: Checkout code
@@ -48,6 +48,9 @@ jobs:
4848

4949
- name: Build library
5050
run: npm run build-only
51+
52+
- name: Build styles
53+
run: npm run build::sass
5154

5255
- name: Build documentation
5356
run: npm run docs:build

docs/.vitepress/config.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,21 @@ export default defineConfig({
55
description: 'Guide your users through your application quickly and easily.',
66
lang: 'en-US',
77
base: '/vuejs-tour/',
8+
vite: {
9+
css: {
10+
preprocessorOptions: {
11+
scss: {
12+
api: 'modern-compiler',
13+
},
14+
},
15+
},
16+
},
817
themeConfig: {
918
logo: 'https://vuejs.org/images/logo.png',
1019
nav: [
1120
{ text: 'Guide', link: '/guide/what-is-vuejs-tour' },
1221
{
13-
text: '2.1.1',
22+
text: '2.4.2',
1423
items: [
1524
{
1625
text: 'Changelog',

docs/guide/create-a-tour.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ First of all, you need to create an array of steps. Each step should have a `tar
2323
```
2424

2525
After creating the steps, you need to pass them to the `VTour` component as a prop.
26-
```vue{2}
26+
```vue
2727
<template>
2828
<VTour/> // [!code --]
2929
<VTour :steps="steps"/> // [!code ++]

docs/guide/getting-started.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can try VueJS Tour directly in your browser on [StackBlitz](https://stackbli
77
## Installation
88

99
### Prerequisites
10-
- [Node.js](https://nodejs.org/) version 18.3 or higher.
10+
- [Node.js](https://nodejs.org/) version 20 or higher.
1111
- [Vue 3.x](https://vuejs.org/) or higher.
1212
- Terminal for installing VueJS Tour.
1313

@@ -50,20 +50,5 @@ We are also importing the default styles of VueJS Tour.
5050
<HelloWorld msg="Vite + Vue" />
5151
</template>
5252
```
53-
::: danger Breaking Changes
54-
Since version 2.0.1, VueJS Tour has been rewritten in TypeScript. The `VTour` component is now a named export and must be imported as such.
55-
::: details Version 1.x.x
56-
Import the plugin in your application entry point (`main.js`) file.
57-
```js{3,4,7}
58-
import { createApp } from "vue";
59-
import App from "./App.vue";
60-
import VueJsTour from '@globalhive/vuejs-tour';
61-
import '@globalhive/vuejs-tour/dist/style.css';
62-
63-
const app = createApp(App)
64-
.use(VueJsTour)
65-
.mount("#app");
66-
```
67-
:::
6853

6954
Everything is now set up, and you can start [creating your first tour](./create-a-tour).

0 commit comments

Comments
 (0)