index

Functions

studioCMSBlogPlugin()

function studioCMSBlogPlugin(options?: {
  blog: {
     enableRSS: boolean;
     route: string;
     title: string;
    };
  favicon: string;
  htmlDefaultHead: {
     attrs: Record<string, undefined | string | boolean>;
     content: string;
     tag:   | "title"
        | "link"
        | "base"
        | "meta"
        | "noscript"
        | "script"
        | "style"
        | "template";
    }[];
  htmlDefaultLanguage: string;
  injectRoutes: boolean;
  sitemap: boolean;
 }): StudioCMSPlugin

Defined in: studiocms/packages/@studiocms/blog/src/index.ts:39^

Creates and configures the StudioCMS Blog plugin.

Parameters

options?

Optional configuration options for the blog plugin.

blog

{ enableRSS: boolean; route: string; title: string; } = ...

The configuration for the blog

blog.enableRSS

boolean = ...

Enable RSS feed

blog.route

string = ...

The route for the blog

Default

'/blog'

Example

'/news'

blog.title

string = ...

The title of the blog

favicon

string = ...

Favicon Configuration - The default favicon configuration for the Frontend

htmlDefaultHead

{ attrs: Record<string, undefined | string | boolean>; content: string; tag: | "title" | "link" | "base" | "meta" | "noscript" | "script" | "style" | "template"; }[] = ...

HTML Default Header - The default head configuration for the Frontend

htmlDefaultLanguage

string = ...

HTML Default Language - The default language for the HTML tag

Default

'en'

injectRoutes

boolean = ...

Inject routes

Default

true

sitemap

boolean = ...

Enable sitemap generation

Default

true

Returns

StudioCMSPlugin

The configured StudioCMS plugin.

Remarks

This function sets up the StudioCMS Blog plugin with the provided options or default values. It configures the plugin’s identifier, name, minimum version, frontend navigation links, page types, sitemap settings, and integration hooks.

Example

const blogPlugin = studioCMSBlogPlugin({
  blog: {
    title: 'My Blog',
    enableRSS: true,
    route: '/my-blog'
  },
  sitemap: true,
  injectRoutes: true
});

References

default

Renames and re-exports studioCMSBlogPlugin