Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/limdongjin/vuepress-plugin-simple-seo

npm package for vuepress, SEO
https://github.com/limdongjin/vuepress-plugin-simple-seo

javascript npm-package seo vuejs vuepress vuepress-plugin

Last synced: about 2 months ago
JSON representation

npm package for vuepress, SEO

Host: GitHub
URL: https://github.com/limdongjin/vuepress-plugin-simple-seo
Owner: limdongjin
License: mit
Created: 2019-01-16T21:25:39.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-05-11T00:32:17.000Z (over 2 years ago)
Last Synced: 2024-11-05T22:15:27.376Z (2 months ago)
Topics: javascript, npm-package, seo, vuejs, vuepress, vuepress-plugin
Language: JavaScript
Homepage: https://www.npmjs.com/package/@limdongjin/vuepress-plugin-simple-seo
Size: 6.65 MB
Stars: 8
Watchers: 1
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# vuepress-plugin-simple-seo

> Simple Seo plugin for Vuepress 1.x

[![npm version](https://img.shields.io/npm/v/vuepress-plugin-feed.svg?style=flat-square)](https://www.npmjs.com/package/@limdongjin/vuepress-plugin-simple-seo)
[![MIT License](https://img.shields.io/npm/l/express.svg?style=flat-square)](http://opensource.org/licenses/MIT)

## Install

```
yarn add -D @limdongjin/vuepress-plugin-simple-seo
```

## Usage

```js
module.exports = {
plugins: ['@limdongjin/vuepress-plugin-simple-seo', {
// write options. ( all options are optional )
}]
}
```

## Example Usage1

```js
// config.js
module.exports = {
plugins: ['@limdongjin/vuepress-plugin-simple-seo', {
default_image: '/images/main-image-min.jpg',
root_url: 'https://limdongjin.github.io',
default_site_name: 'limdongjin TIL'
}]
}
```

```md
---
description: It is Simple Seo Plugin for Vuepress
image: '/post-specific-image.png'
twitter_creator: twituser
twitter_site: twituser
---

# It is automatic title.

hello world

## gogo
```

```html

```

## Options

- recommend option are also "optional" option.
- Type: `string`

### root_url (recommend)

- Default: Empty String
- Example: `https://limdongjin.github.io`

```html

```
### default_site_name (recommend)

- Default: `undefined`

```html

```

### default_image (recommend)

- Default: `undefined`
- Example, `/image.png`

```html

```

### default_image_type

- Default: `undefined`

```html

```

### default_image_width

- Default: `undefined`

```html

```

### default_image_height

- Default: `undefined`

```html

```

### default_image_alt

- Default: `undefined`

```html

```

### default_twitter_creator

- Default: `undefined`

```html

```

### default_twitter_site

- Default: `undefined`

```html

```

### default_twitter_card

- Default: `summary`

```html

```

### default_og_type

- Default: `article`

```html

```

## Frontmatter

- each page can override default option values.
- if you want minimal setting, recommend just set description, or image.

### title

if you are not write frontmatter title, create meta title tag from $page.title.

```html

```

### description ( recommend )

```html

```

### image ( recommend )

```html

```

### image_type

```html

```

### image_width

```html

```

### image_height

```html

```

### image_alt

```html

```

### twitter_creator

- Example: twituser

```html

```

### twitter_site

- Example: twituser

```html

```

### twitter_card

```html

```

### og_type

```html

```

### site_name

```html

```

## License