Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit c18fb13

Browse files
committed
docs: add comment section to getting-started
1 parent de002ec commit c18fb13

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

docs/guide/getting-started.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,63 @@ classification:
317317

318318
- [Config > frontmatters](../config/README.md#frontmatters)
319319

320+
## Comment
321+
322+
Comment is a great way to make your blog much more lively. We integrate client side comment services: [Vssue](https://vssue.js.org/) and [Disqus](https://disqus.com/) in this plugin. The former is a vue-powered and issue-based open source project which can enable comments for your static pages, while the latter is a networked platform that provides comment service used by hundreds of thousands of websites.
323+
324+
> A plugin can contain several plugins like a preset.
325+
326+
Since comment is implemented by other plugins, make sure you've read [vuepress-plugin-vssue](https://vssue.js.org/) or [vuepress-plugin-disqus-comment](https://vuepress-plugin-disqus.netlify.com) before using them:
327+
```js
328+
// .vuepress/config.js
329+
module.exports = {
330+
plugins: [
331+
[
332+
'@vuepress/blog',
333+
{
334+
comment: [
335+
{
336+
// Which service you'd like to use
337+
service: 'vssue',
338+
// The owner's name of repository to store the issues and comments.
339+
owner: 'You',
340+
// The name of repository to store the issues and comments.
341+
repo: 'Your repo',
342+
// The clientId & clientSecret introduced in OAuth2 spec.
343+
clientId: 'Your clientId',
344+
clientSecret: 'Your clientSecret',
345+
},
346+
],
347+
},
348+
],
349+
],
350+
}
351+
```
352+
```js
353+
// .vuepress/config.js
354+
module.exports = {
355+
plugins: [
356+
[
357+
'@vuepress/blog',
358+
{
359+
comment: [
360+
{
361+
// Which service you'd like to use
362+
service: 'disqus',
363+
// The owner's name of repository to store the issues and comments.
364+
shortname: 'vuepress-plugin-blog',
365+
},
366+
],
367+
},
368+
],
369+
],
370+
}
371+
```
372+
373+
::: tip
374+
Of course you can use whatever service you like or roll your own comment system. Just simply ignore the config.
375+
:::
376+
320377

321378
## Writing a blog theme
322379

0 commit comments

Comments
 (0)