Draft

The Draft block type hides its contents when building your site. This is useful for adding work-in-progress content that you can only see while running astro dev.

It looks like this, i.e. like nothing!

Example

Usage

Import Draft in astro.config.mjs and use it in the starlightMarkdownBlocks configuration:

astro.config.mjs

import starlight from '@astrojs/starlight';
import { defineConfig } from 'astro/config';
import starlightMarkdownBlocks, { Draft } from 'starlight-markdown-blocks';

export default defineConfig({
  integrations: [
    starlight({
      title: 'My Docs',
      plugins: [
        starlightMarkdownBlocks({
          blocks: {
            draft: Draft(),
          },
        }),
      ],
    }),
  ],
});

Options

The Draft block accepts the following options.

label

Type: string
Default: "Draft"

The label to display during development to indicate draft content.