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
+8-8
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ This is a basic starter project for a prerendered [Vue.js](https://vuejs.org/) +
6
6
7
7
### [You can view the deployed app here](https://nuxt-netlify-lambda-starter.netlify.com/)
8
8
9
-
####Features
9
+
### Features
10
10
- Home and About Pages
11
11
-`HelloWorld` example Lambda function with associated frontend code
12
12
- Pre-rendered dynamic pages using a sample `Item` datatype
@@ -16,7 +16,7 @@ This is a basic starter project for a prerendered [Vue.js](https://vuejs.org/) +
16
16
17
17
**NOTE:** this project can only be deployed via Netlify with [continuous deployment](https://www.netlify.com/docs/continuous-deployment/) enabled.
18
18
19
-
####Build Setup
19
+
### Build Setup
20
20
21
21
```bash
22
22
# Install dependencies
@@ -29,7 +29,7 @@ $ yarn run dev
29
29
$ yarn run build
30
30
```
31
31
32
-
####Pre-rendered Dynamic Pages
32
+
### Pre-rendered Dynamic Pages
33
33
34
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
35
@@ -41,7 +41,7 @@ generate: {
41
41
42
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
43
44
-
####Environment Configuration
44
+
### Environment Configuration
45
45
The following production environment variables are required for the respective plugins to work correctly:
These variables can be configured in a variety of ways - please consult the [Netlify Continuous Deployment Docs](https://www.netlify.com/docs/continuous-deployment/#environment-variables). You can deactivate any of these plugins by modifying the `plugins` field in the `nuxt.config.js` file.
61
61
62
-
####JSON-LD Structured Data
62
+
### JSON-LD Structured Data
63
63
64
64
The [JSON-LD Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) can be updated by modifying the `jsonld()` function in the `layouts/default.vue` file. This feature shouldn't be used anywhere else - one `JSON-LD` snippet should describe the entire site.
65
65
66
-
####Bootstrap + SASS Configuration
66
+
### Bootstrap + SASS Configuration
67
67
68
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 :)
69
69
70
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
71
72
-
####FontAwesome Vue Configuration
72
+
### FontAwesome Vue Configuration
73
73
74
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