Skip to content

@astrojs/markdown-satteri: JSDoc shows that the smartPunctuation default is false #17305

Description

@adamhl8

Astro Info

Astro                    v7.0.6
Node                     v26.3.0
System                   macOS (arm64)
Package Manager          nub
Output                   static
Adapter                  @astrojs/node
Integrations             astro-expressive-code
                         @astrojs/mdx
                         @astrojs/sitemap
                         @astrojs/react

Describe the Bug

// astro.config.ts
  markdown: {
    processor: satteri({
      features: {
        smartPunctuation: false,
      },
    }),
  }

If you mouseover the smartPunctuation property in the object passed to satteri in the markdown config, it says that the default is false:

Smart punctuation à la SmartyPants. Default: false.

But Astro defaults smartPunctuation to true.

I know the JSDoc comes from the upstream satteri package, so I'm not even sure if this is fixable.

Just wanted to bring it to your attention because it took me a minute to figure out why smartPunctuation was on when it seemed like it should have been off by default.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions