13 | 
14 |
15 | Easy 
43 |
44 | See the documentation on [Content API authentication](https://ghost.org/docs/content-api/#authentication) for more explanation.
45 |
46 | ## Endpoints
47 |
48 | All endpoints & parameters provided by the [Content API](https://ghost.org/docs/content-api/) are supported.
49 |
50 | ```ts
51 | // Browsing posts returns Promise([Post...]);
52 | // The resolved array will have a meta property
53 | this.$ghost.posts.browse({ limit: 2, include: 'tags,authors' });
54 | this.$ghost.posts.browse();
55 |
56 | // Reading posts returns Promise(Post);
57 | this.$ghost.posts.read({ id: 'abcd1234' });
58 | this.$ghost.posts.read({ slug: 'something' }, { formats: ['html', 'plaintext'] });
59 |
60 | // Browsing authors returns Promise([Author...])
61 | // The resolved array will have a meta property
62 | this.$ghost.authors.browse({ page: 2 });
63 | this.$ghost.authors.browse();
64 |
65 | // Reading authors returns Promise(Author);
66 | this.$ghost.authors.read({ id: 'abcd1234' });
67 | this.$ghost.authors.read({ slug: 'something' }, { include: 'count.posts' }); // include can be array for any of these
68 |
69 | // Browsing tags returns Promise([Tag...])
70 | // The resolved array will have a meta property
71 | this.$ghost.tags.browse({ order: 'slug ASC' });
72 | this.$ghost.tags.browse();
73 |
74 | // Reading tags returns Promise(Tag);
75 | this.$ghost.tags.read({ id: 'abcd1234' });
76 | this.$ghost.tags.read({ slug: 'something' }, { include: 'count.posts' });
77 |
78 | // Browsing pages returns Promise([Page...])
79 | // The resolved array will have a meta property
80 | this.$ghost.pages.browse({ limit: 2 });
81 | this.$ghost.pages.browse();
82 |
83 | // Reading pages returns Promise(Page);
84 | this.$ghost.pages.read({ id: 'abcd1234' });
85 | this.$ghost.pages.read({ slug: 'something' }, { fields: ['title'] });
86 |
87 | // Browsing settings returns Promise(Settings...)
88 | // The resolved object has each setting as a key value pair
89 | this.$ghost.settings.browse();
90 | ```
91 |
92 | For all resources except settings, the browse() method will return an array of objects, and the read() method will return a single object. The settings.browse() endpoint always returns a single object with all the available key-value pairs.
93 |
94 | See the documentation on [Content API resources](https://ghost.org/docs/content-api/#resources) for a full description of the response for each resource.
95 |
96 | ## Filtering
97 |
98 | Ghost provides the `filter` parameter to fetch your content with endless possibilities! Especially useful for retrieving posts according to their tags, authors or other properties.
99 |
100 | Ghost uses the NQL query language to create filters in a simple yet powerful string format. See the [NQL Syntax Reference](https://ghost.org/docs/content-api/#filtering) for full details.
101 |
102 | Filters are provided to client libraries via the `filter` property of any `browse` method.
103 |
104 | ```ts
105 | this.$ghost.posts.browse({ filter: 'featured:true' });
106 | ```
107 |
108 | Incorrectly formatted filters will result in a 400 Bad Request Error. Filters that don’t match any data will return an empty array.
109 |
110 | ### Example
111 |
112 | ```vue
113 |
134 | ```
135 |
136 | ### Common Filters
137 |
138 | - `featured:true` - all resources with a field `featured` that is set to `true`.
139 | - `featured:true+feature_image:null` - looks for featured posts which don’t have a feature image set by using `+` (and).
140 | - `tag:hash-noimg` - `tag` is an alias for `tags.slug` and `hash-noimg` would be the slug for an internal tag called `#NoImg`. This filter would allow us to find any post that has this internal tag.
141 | - `tags:[photo, video, audio]` - filters posts which have any one of the listed tags, `[]` (grouping) is more efficient than using or when querying the same field.
142 | - `primary_author:my-author` - `primary_author` is an alias for the first author, allowing for filtering based on the first author.
143 | - `published_at:>'2017-06-03 23:43:12'` - looks for posts published after a date, using a date string wrapped in single quotes and the `>` operator
144 |
145 | ## JavaScript SDK
146 |
147 | A collection of packages for common API usecases
148 |
149 | ### Helpers
150 |
151 | - Package: `@tryghost/helpers`
152 | - Builds: CJS, ES, UMD
153 | The shared helpers are designed for performing data formatting tasks, usually when creating custom frontends.
154 |
155 | #### Tags
156 |
157 | Filters and outputs tags. By default, the helper will output a comma separated list of tag names, excluding any internal tags.
158 |
159 | ```ts
160 | import { tags } from '@tryghost/helpers';
161 |
162 | const posts = await this.$ghost.posts.browse({
163 | filter: 'tag:fiction+tag:-fables',
164 | });
165 |
166 | // Outputs e.g. Posted in: New Things, Releases, Features.
167 | posts.forEach((post) => {
168 | tags(post, { prefix: 'Posted in: ', suffix: '.' });
169 | });
170 | ```
171 |
172 | The first argument must be a post object, or any object that has a `tags` array.
173 |
174 | ##### Options
175 |
176 | The tag helper supports multiple options so that you can control exactly what is output, without having to write any logic.
177 |
178 | - `limit` {integer} - limits the number of tags to be returned
179 | - `from` {integer, default:1} - index of the tag to start iterating from
180 | - `to` {integer} - index of the last tag to iterate over
181 | - `separator` {string, default:","} - string used between each tag
182 | - `prefix` {string} - string to output before each tag
183 | - `suffix` {string} - string to output after each tag
184 | - `visibility` {string, default:“public”} - change to “all” to include internal tags
185 | - `fallback` {object} - a fallback tag to output if there are none
186 | - `fn` {function} - function to call on each tag, default returns tag.name
187 | Reading
188 |
189 | #### Reading Time
190 |
191 | Calculates the estimated reading time based on the HTML for a post & available images.
192 |
193 | ```ts
194 | import { readingTime } from '@tryghost/helpers';
195 |
196 | const posts = await this.$ghost.posts.browse();
197 |
198 | // Outputs e.g. A 5 minute read.
199 | posts.forEach((post) => {
200 | readingTime(post, { minute: 'A 1 minute read.', minutes: 'A % minute read.' });
201 | });
202 | ```
203 |
204 | The first argument must be a post object, or any object that has an `html` string. If a `feature_image` is present, this is taken into account.
205 |
206 | ##### Options
207 |
208 | The output of the reading time helper can be customised through format strings.
209 |
210 | - `minute` {string, default:“1 min read”} - format for reading times <= 1 minute
211 | - `minutes` {string, default:"% min read"} - format for reading times > 1 minute
212 |
213 | ### String
214 |
215 | - Package: `@tryghost/string`
216 | - Builds: CJS
217 |
218 | Utilities for processing strings.
219 |
220 | #### Slugify
221 |
222 | The function Ghost uses to turn a post title or tag name into a slug for use in URLs.
223 |
224 | ```ts
225 | const { slugify } = require('@tryghost/string');
226 | const slug = slugify('你好 👋!'); // slug === "ni-hao"
227 | ```
228 |
229 | The first argument is the string to transform. The second argument is an optional options object.
230 |
231 | ##### Options
232 |
233 | The output can be customised by passing options
234 |
235 | - `requiredChangesOnly` {boolean, default:false} - don’t perform optional cleanup, e.g. removing extra dashes
236 |
--------------------------------------------------------------------------------
/docs/content/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Nuxt Ghost",
3 | "url": "https://nuxt-ghost.vercel.app/",
4 | "logo": {
5 | "light": "/logo-light.svg",
6 | "dark": "/logo-dark.svg"
7 | },
8 | "github": "Gomah/nuxt-ghost",
9 | "twitter": "@gomah",
10 | "defaultBranch": "master"
11 | }
12 |
--------------------------------------------------------------------------------
/docs/nuxt.config.js:
--------------------------------------------------------------------------------
1 | import theme from '@nuxt/content-theme-docs';
2 |
3 | export default theme({
4 | docs: {
5 | primaryColor: '#828486',
6 | },
7 | });
8 |
--------------------------------------------------------------------------------
/docs/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "nuxt-ghost-docs",
3 | "version": "1.0.12",
4 | "description": "Docs for nuxt-ghost",
5 | "private": true,
6 | "author": {
7 | "name": "Gomah
5 |
16 |
6 |
15 |
7 |
11 | 8 | {{ post.title }} 9 |
10 |
12 |
13 |
14 |
3 |
22 |
23 |
24 |
46 |
--------------------------------------------------------------------------------
/example/components/navbar.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 | ![]()
6 |
7 |
8 |
9 |
21 |
10 |
16 |
17 |
11 |
12 | {{ title }}
13 |
14 |
15 |
18 | {{ excerpt }}
19 |
20 |
3 |
28 |
29 |
30 |
31 |
40 |
--------------------------------------------------------------------------------
/example/layouts/default.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 |
28 |
29 |
30 |
5 |
14 |
15 |
6 |
13 |
4 |
28 |
29 |
30 |
5 |
14 |
15 |
6 |
13 |