Skip to content

Generate excerpt from your elderjs markdown blog post. This plugin will add or override your excerpt generate by markdown plugin.

License

Notifications You must be signed in to change notification settings

noxasch/elderjs-plugin-blog-excerpt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Elder.js Plugin: elderjs-plugin-blog-excerpt

Generate excerpt from your markdown blog post. This plugin will add or override your excerpt generate by markdown plugin.

Prerequisite

Currently this plugin only support post generate by @elderjs/plugin-markdown

npm install --save @elderjs/plugin-markdown

Install

npm i elderjs-plugin-blog-excerpt

Config

Once installed, open your elder.config.js and configure the plugin by adding 'elder-plugin-your-plugin' to your plugin object.

plugins: {

  'elderjs-plugin-blog-excerpt': {
    routes: ['blog'],
    overrideExcerpt: true,
  },

}

Default Config

plugins: {

  'elderjs-plugin-your-plugin': {
    routes: [],
    maxWordsCount: 55,
    excludeHeadings: true, // exclude headings from excerpt
    excludeCodeBlock: true, // exclude headings from excerpt
    excludeListItem: true, // exclude headings from excerpt
  },
}

Example Usage in Index

<script>
  export let data, request, helpers, settings
  const blogPost = data.markdown.blog
</script>


<div class="wrapper">
  {#each blogPost as blog}
    <PostList {blog} {helpers}/>
    <div>
      <div>{blog.frontmatter.excerpt}</div>
    </div>
  {/each}
</div>

Example Usage in Template

<script>
  export let data, request, helpers, settings
  const { html, frontmatter } = data;
</script>

<svelte:head>
  <title>{frontmatter.title}</title>
  <meta name="description" content={frontmatter.excerpt} />
</svelte:head>

<div class="wrapper">
  {#if html}
    {@html html}
  {:else}
    <h1>Oops!! Markdown not found!</h1>
  {/if}
</div>

TODO

  • add unit test
  • add github action

About

Generate excerpt from your elderjs markdown blog post. This plugin will add or override your excerpt generate by markdown plugin.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published