leblog

Add a blog (or changelog) to any SvelteKit site.

Installation

npm install leblog

Usage

leblog works by loading your posts through +page.server.js files, which you can then render with the included Entry component.

1. Install the plugin

In vite.config.js:

...
import leblog from 'leblog'

export default defineConfig({
  plugins: [leblog(), ...]
})

2. Write your posts

By default it looks in posts in the root of your project for markdown files (configurable), formatted as yyyy-mm-dd-{ slug }.md.

Entries beginning with an underscore (_) are drafts and will only be included in development.

3. Load your posts

On any page or in any component:

import { load } from 'leblog'

const posts = load('posts') // or `load('posts/${slug}')` for a specific one

And then to render it:

<ul>
  {#each posts as post}
    <li>
      <h2>{post.title}</h2>

      {@html post.html}
    </li>
  {/each}
</ul>

Each entry will have the following properties:

export type Entry = {
  collection: string
  data: Object<string, any> // YAML frontmatter
  title: string
  slug: string
  raw: string
  is_draft: boolean
  date?: string // empty in some changelog cases
}

In addition, changelog entries have an optional version field.

Configuration (optional)

leblog looks for a leblog.config.js file in the root of directory of your project. If it doesn't find one, it will use the following defaults:

export default {
  collections: {
    posts: 'posts',
    updates: {
      path: '/path/to/updates',
      feed: '/route/feed.rss'
    }
  }
}

collections is a an object where the key is the name of the collection and the value is either the path to the directory containing the markdown files, or an object like the updates above.

changelog is a special key, whose value can either be a path to a directory containing markdown files, or a single markdown file adhering to the keepachangelog.com standards.

Atom/RSS feeds

To add an RSS or Atom feed, specify the feed key in a collection entry, using either an rss, atom or json extension (e.g. /feed.rss).

Todo

• [x] Draft posts
• [x] RSS feeds
• [ ] Pagination
• [ ] Code syntax highlighting
• [ ] Authors

Thanks

• micromark for the markdown rendering.
• gray-matter for parsing YAML frontmatter.
• changelog-parser for parsing changelog files.

License

MIT