Skip to content

Commit 5abb61c

Browse files
committed
Cleaned up README.md headers
1 parent 30eab14 commit 5abb61c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This is a basic starter project for a prerendered [Vue.js](https://vuejs.org/) +
66

77
### [You can view the deployed app here](https://nuxt-netlify-lambda-starter.netlify.com/)
88

9-
#### Features
9+
### Features
1010
- Home and About Pages
1111
- `HelloWorld` example Lambda function with associated frontend code
1212
- 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/) +
1616

1717
**NOTE:** this project can only be deployed via Netlify with [continuous deployment](https://www.netlify.com/docs/continuous-deployment/) enabled.
1818

19-
#### Build Setup
19+
### Build Setup
2020

2121
``` bash
2222
# Install dependencies
@@ -29,7 +29,7 @@ $ yarn run dev
2929
$ yarn run build
3030
```
3131

32-
#### Pre-rendered Dynamic Pages
32+
### Pre-rendered Dynamic Pages
3333

3434
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`:
3535

@@ -41,7 +41,7 @@ generate: {
4141

4242
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.
4343

44-
#### Environment Configuration
44+
### Environment Configuration
4545
The following production environment variables are required for the respective plugins to work correctly:
4646

4747
```bash
@@ -59,21 +59,21 @@ MAILCHIMP_UUID=aabbccddeeffgghhiijj12345
5959

6060
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.
6161

62-
#### JSON-LD Structured Data
62+
### JSON-LD Structured Data
6363

6464
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.
6565

66-
#### Bootstrap + SASS Configuration
66+
### Bootstrap + SASS Configuration
6767

6868
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 :)
6969

7070
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.
7171

72-
#### FontAwesome Vue Configuration
72+
### FontAwesome Vue Configuration
7373

7474
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).
7575

76-
#### References
76+
### References
7777
- [Vue.js](https://vuejs.org)
7878
- [Nuxt.js](https://nuxtjs.org)
7979
- [Netlify Functions](https://www.netlify.com/docs/functions/)

0 commit comments

Comments
 (0)