@studiocms/blog

Introduction

Powered by astro-theme-provider by Bryce Russell

This Astro integration enables the StudioCMS Blog feature in your Astro project. This integration will allow you to create, edit, and delete blog posts in the StudioCMS dashboard.

Installation

Astro Method

1. Install the package and add to your astro config using the following command:

   npm

   npx astro add @studiocms/blog

   yarn

   yarn astro add @studiocms/blog

   pnpm

   pnpm astro add @studiocms/blog

2. Update your config file as shown under Example Config below.

Manual Method

1. Install the package using the following command:

   npm

   npm i @studiocms/blog

   yarn

   yarn add @studiocms/blog

   pnpm

   pnpm add @studiocms/blog

2. Add @studiocms/blog to your astro config file:

   astro.config.mjs

   import { defineConfig } from 'astro/config';
   import node from '@astrojs/node';
   import db from '@astrojs/db';
   import studioCMS from 'studiocms';
   import studioCMSBlog from '@studiocms/blog';
   
   export default defineConfig({
      site: 'https://demo.astro-studiocms.xyz/',
      output: 'server',
      adapter: node({ mode: "standalone" }),
      integrations: [
          db(),
          studioCMS({
              dbStartPage: true, // After the first time running the dev server and following the instructions at http://localhost:4321/start this will be set to false.
          }),
          studioCMSBlog({
              config: {
              title: "My StudioCMS Blog",
              description: "A Simple Blog build with Astro, AstroDB, and StudioCMS.".
              },
          }),
      ],
   });

Usage

What does this integration do?

This integration will add the following new routes to your StudioCMS Controlled front-end:

• /blog - The main blog page that lists all blog posts.
• /blog/[slug] - The individual blog post page.
• /rss.xml - The RSS feed for your blog posts.

Example config

astro.config.mjs

import { defineConfig } from 'astro/config';
import db from '@astrojs/db';
import studioCMS from 'studiocms';
import studioCMSBlog from '@studiocms/blog';

// https://astro.build/config
export default defineConfig({
  site: "https://example.com",
  output: "server",
  adapter: ...
  integrations: [
    db(), // REQUIRED - `@astrojs/db` must be included in the integrations list
    studioCMS(), // REQUIRED - StudioCMS must be included in the integrations list
    studioCMSBlog({
      config: {
        title: "My StudioCMS Blog",
        description: "A Simple Blog build with Astro, Astrojs/DB, and StudioCMS.".
      },
    }),
  ],
});