starlight-blog

Starlight plugin to add a blog to your documentation

MIT License

Downloads
2.8K
Stars
84
Committers
7

Bot releases are visible (Hide)

starlight-blog - v0.8.2 Latest Release

Published by github-actions[bot] 5 months ago

   🐞 Bug Fixes

  • Fixes a 404 RSS feed sidebar link error when using the Astro trailingSlash option set to always  -  by @HiDeoo (8e1d5)
    View changes on GitHub
starlight-blog - v0.8.1

Published by github-actions[bot] 5 months ago

   🚀 Features

  • Adds a social link to Starlight for the blog RSS feed  -  by @HiDeoo (c506b)

   🐞 Bug Fixes

  • Fixes an RSS feed image rendering issue by temporarily replacing images with a placeholder  -  by @HiDeoo (9f33e)
    View changes on GitHub
starlight-blog - v0.8.0

Published by github-actions[bot] 5 months ago

   🚀 Features

  • Adds an RSS feed to the generated blog  -  by @HiDeoo (e4ddb)
    The feature is automatically enabled when the Astro site option is set in astro.config.mjs.
    View changes on GitHub
starlight-blog - v0.7.1

Published by github-actions[bot] 6 months ago

   🐞 Bug Fixes

  • Prevents the blog post and tag lists from being included in the Pagefind search index to avoid duplicated search results  -  by @HiDeoo (0f82e)
  • Prevents blog navigation links from being included in the Pagefind search index to avoid duplicated search results  -  by @HiDeoo (98967)
    View changes on GitHub
starlight-blog - v0.7.0

Published by github-actions[bot] 6 months ago

   🚨 Breaking Changes

  • Bumps minimum required Starlight version to 0.22.1  -  by @HiDeoo (ed23e)

   🚀 Features

  • Add support for draft blog posts  -  by @HiDeoo (eebbb)
    View changes on GitHub
starlight-blog - v0.6.0

Published by github-actions[bot] 6 months ago

   🚀 Features

  • Respects the Astro trailingSlash option  -  by @HiDeoo (e87f6)
  • Adds new prevNextLinksOrder option to control if next links will point to the next blog post towards the past or the future  -  by @HiDeoo (0c12c)
  • Adds support for Markdown in blog post excerpts  -  by @HiDeoo (49cd5)
  • Adds new prefix option to configure the base prefix for all blog routes  -  by @HiDeoo (b6542)
  • Uses Starlight <LinkCard> component for prev/next links  -  by @HiDeoo (75528)

   🐞 Bug Fixes

  • Fixes a TypeScript type issue with the plugin configuration schema  -  by @HiDeoo (d1194)
    View changes on GitHub
starlight-blog - v0.5.1

Published by github-actions[bot] 8 months ago

   🐞 Bug Fixes

  • Fixes issues when using the Astro base option  -  by @HiDeoo (6d893)
    View changes on GitHub
starlight-blog - v0.5.0

Published by github-actions[bot] 8 months ago

   🚨 Breaking Changes

  • Bumps minimum required Astro version to 4.2.7 and Starlight to 0.19.0  -  by @HiDeoo (a9fc3)

  • Starlight Blog is now a Starlight plugin  -  by @HiDeoo (bbb9d)

    You will need to update your Astro configuration to remove the previous version and add the new version as a Starlight plugin in your astro.config.mjs file:

    import starlight from "@astrojs/starlight";
    import { defineConfig } from "astro/config";
    import starlightBlog from 'starlight-blog';
    
    export default defineConfig({
      // …
      integrations: [
    -   starlightBlog(),
        starlight({
    +     plugins: [starlightBlog()],
          title: "My Docs",
        }),
      ],
    });
    

    You will also need to update Starlight’s frontmatter schema in the src/content/config.ts file:

     import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
     import { defineCollection } from 'astro:content';
    -import { docsAndBlogSchema } from 'starlight-blog/schema';
    +import { blogSchema } from 'starlight-blog/schema';
    
    export const collections = {
    - docs: defineCollection({ schema: docsAndBlogSchema }),
    + docs: defineCollection({ schema: docsSchema({ extend: blogSchema() }) }),
      i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
    }
    

   🚀 Features

  • Exports the StarlightBlogConfig TypeScript type representing the user's plugin configuration  -  by @HiDeoo (012f5)
    View changes on GitHub
starlight-blog - v0.4.0

Published by github-actions[bot] about 1 year ago

   🚨 Breaking Changes

  • Bump minimum required Astro version to 3.2.0 and Starlight to 0.11.0  -  by @HiDeoo (d231b)

  • Use Starlight component overrides for custom UI  -  by @HiDeoo (cdf7c)
    You must update your configuration to use the new Starlight component overrides:

    starlight({
    +  components: {
    +    MarkdownContent: 'starlight-blog/overrides/MarkdownContent.astro',
    +    Sidebar: 'starlight-blog/overrides/Sidebar.astro',
    +    ThemeSelect: 'starlight-blog/overrides/ThemeSelect.astro',
    +  },
    }),
    
    View changes on GitHub
starlight-blog - v0.3.2

Published by github-actions[bot] about 1 year ago

   🐞 Bug Fixes

  • Invalid page component import path  -  by @HiDeoo (cf9db)
    View changes on GitHub
starlight-blog - v0.3.1

Published by github-actions[bot] about 1 year ago

   🐞 Bug Fixes

  • Build error with Starlight v0.9.1  -  by @HiDeoo (be007)
    View changes on GitHub
starlight-blog - v0.3.0

Published by github-actions[bot] about 1 year ago

   🚨 Breaking Changes

  • Bump minimum required Astro version to 3.0 and Starlight to 0.9.0  -  by @HiDeoo (64177)

   🐞 Bug Fixes

  • Prevent CSS issues with Starlight v0.8.0  -  by @lorenzolewis and @HiDeoo (53aaf)
    View changes on GitHub
starlight-blog - v0.2.1

Published by github-actions[bot] about 1 year ago

   🐞 Bug Fixes

    View changes on GitHub
starlight-blog - v0.2.0

Published by github-actions[bot] about 1 year ago

   🚀 Features

    View changes on GitHub
starlight-blog - v0.1.1

Published by github-actions[bot] about 1 year ago

   🚀 Features

  • Initial public release.