Starlight plugin to add a blog to your documentation
MIT License
Bot releases are visible (Hide)
trailingSlash
option set to always
- by @HiDeoo (8e1d5)
Published by github-actions[bot] 5 months ago
Published by github-actions[bot] 5 months ago
site
option is set in astro.config.mjs
.Published by github-actions[bot] 6 months ago
Published by github-actions[bot] 6 months ago
Published by github-actions[bot] 6 months ago
trailingSlash
option - by @HiDeoo (e87f6)
prevNextLinksOrder
option to control if next links will point to the next blog post towards the past or the future - by @HiDeoo (0c12c)
prefix
option to configure the base prefix for all blog routes - by @HiDeoo (b6542)
<LinkCard>
component for prev/next links - by @HiDeoo (75528)
Published by github-actions[bot] 8 months ago
base
option - by @HiDeoo (6d893)
Published by github-actions[bot] 8 months ago
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() }),
}
StarlightBlogConfig
TypeScript type representing the user's plugin configuration - by @HiDeoo (012f5)
Published by github-actions[bot] about 1 year ago
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',
+ },
}),
Published by github-actions[bot] about 1 year ago
Published by github-actions[bot] about 1 year ago
Published by github-actions[bot] about 1 year ago
Published by github-actions[bot] about 1 year ago
Published by github-actions[bot] about 1 year ago
title
field - by @lorenzolewis and @HiDeoo in https://github.com/HiDeoo/starlight-blog/issues/2 (f2276)
Published by github-actions[bot] about 1 year ago