You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ This is a basic starter project for a prerendered [Vue.js](https://vuejs.org/) +
12
12
- Pre-rendered dynamic pages using a sample `Item` datatype
13
13
- Integrates with [HotJar](https://hotjar.com"), [Mailchimp](https://mailchimp.com"), and [Google Analytics](https://analytics.google.com/analytics/web/#/)
14
14
- Includes [JSON-LD Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data)
15
+
- Customizable UI using [Bootstrap](https://getbootstrap.com) & [SASS](https://sass-lang.com) variables
15
16
16
17
**NOTE:** this project can only be deployed via Netlify with [continuous deployment](https://www.netlify.com/docs/continuous-deployment/) enabled.
17
18
@@ -28,6 +29,18 @@ $ yarn run dev
28
29
$ yarn run build
29
30
```
30
31
32
+
#### Pre-rendered Dynamic Pages
33
+
34
+
This project includes a series of pre-rendered pages using a generic `Item` datatype. The data for these pages is maintained in `assets/content/items.json` and they're generated with a custom `generate` field in `nuxt.config.js`:
35
+
36
+
```js
37
+
generate: {
38
+
routes:items.map(g=>'/items/'+g.id)
39
+
}
40
+
```
41
+
42
+
This ensures that each item has a page that's pre-renderd and SEO-optimized. You can clone, modify, or remove the `Item` datatype and associated pages to better suit your needs.
43
+
31
44
#### Environment Configuration
32
45
The following production environment variables are required for the respective plugins to work correctly:
33
46
@@ -54,6 +67,8 @@ The [JSON-LD Structured Data](https://developers.google.com/search/docs/guides/i
54
67
55
68
You can modify the `assets/sass/main.sass` file to optionally include Bootstrap component styles as-needed. **PROTIP** - only include the Bootstrap components your app depends on - this will keep your CSS bundle nice and slim :)
56
69
70
+
You can also modify any of [Bootstrap's SASS Variables](https://github.com/twbs/bootstrap/blob/master/scss/_variables.scss) inside the `assets/sass/variables.sass` file to customize the framework to your liking.
71
+
57
72
#### FontAwesome Vue Configuration
58
73
59
74
The repo includes a minimal subset of icons by default. When you need an additional icon, you must import it directly in `plugins/fontawesome.js` and register it with the FontAwesome plugin. You can learn more about the Vue-FontAwesome library [here](https://github.com/FortAwesome/vue-fontawesome).
0 commit comments