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
> NuxtJS module to easily interact with the 👻 Ghost API
@@ -35,7 +37,7 @@ After that you need to register the plugin, that NuxtJS can pick it up. To do th
35
37
```
36
38
37
39
## Configuration
38
-
The plugin needs an api key of your site and its endpoint url. Optionally you can pass the version of the Ghost API you want to use. Typically the endpoint for your api is your sites hostname.
40
+
The plugin needs an API key of your site and its endpoint URL. Optionally you can pass the version of the Ghost API you want to use. Typically the endpoint for your API is your sites hostname.
39
41
40
42
To set these values you have two options:
41
43
1. Use the default module options
@@ -59,7 +61,7 @@ When registering the module, don't register it as a string, but an array. The sy
59
61
```
60
62
61
63
#### Global Configuration
62
-
To set up global configuration, add the following object to your `export` of `nuxt.config.js`:
64
+
To set up a global configuration, add the following object to your `export` of `nuxt.config.js`:
63
65
```js
64
66
ghost: {
65
67
url:'YOUR_API_ENDPOINT',
@@ -70,8 +72,8 @@ ghost: {
70
72
#### Environment Variables
71
73
If you don't want sensitive data in your code, or got multiple environments, you can use environment variables to configure this plugin.
72
74
73
-
`GHOST_API_KEY`: Sets the api key.
74
-
`GHOST_API_URL`: Sets the api endpoint.
75
+
`GHOST_API_KEY`: Sets the API key.
76
+
`GHOST_API_URL`: Sets the API endpoint.
75
77
76
78
## Usage
77
79
The usage is pretty straight forward. This package is just a wrapper for the official [JavaScript Content API](https://ghost.org/docs/api/v3/content/). Please check out their documentation to learn about [filtering](https://ghost.org/docs/api/v3/content/#parameters) or [pagination](https://ghost.org/docs/api/v3/content/#pagination). The `filter` parameter of the following methods is an `object` representation of the available query filters.
0 commit comments