plugin-post-suggestions

post-suggestion plugin for vuepress

Usage no npm install needed!

<script type="module">
  import pluginPostSuggestions from 'https://cdn.skypack.dev/plugin-post-suggestions';
</script>

README

plugin-post-suggestions

A unofficial Vuepress plugin to add a suggestion box of similar posts to a webpage.

Installation

Install the plugins module:

yarn add plugin-post-suggestions

Enable the plugin by adding it to the vuepress project's plugins:

plugins: [
    ['../../node_modules/plugin-post-suggestions']
]

Adding Components

The plugin has one component that you can add to your layout. This component will create a grid of posts to suggest for the user. This is based on the tags listed for the current post the user is reading.

<div>
    <PostSuggestions />
</div>

<script>
import PostSuggestions from "@PostSuggestions"

export default {
  components: {
    PostSuggestions,
  }
}
</script>

Configuration

At the moment there is no configuration available for the plugin. Some possible improvements could be:

  • Number of suggestions to show
  • Tags vs Categories