Skip to content

feat: toggle content heading extraction #3400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
farnabaz merged 1 commit into from
Jun 11, 2025
Merged

feat: toggle content heading extraction #3400

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/types/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { BuiltinLanguage as ShikiLang, BuiltinTheme as ShikiTheme, LanguageRegistration, ThemeRegistrationAny, ThemeRegistrationRaw } from 'shiki'
import type { ListenOptions } from 'listhen'
import type { LanguageRegistration, BuiltinLanguage as ShikiLang, BuiltinTheme as ShikiTheme, ThemeRegistrationAny, ThemeRegistrationRaw } from 'shiki'
import type { GitInfo } from '../utils/git'
import type { MarkdownPlugin } from './content'
import type { PathMetaOptions } from './path-meta'
Expand Down Expand Up @@ -110,6 +110,15 @@ export interface ModuleOptions {
*/
searchDepth?: number
}
/**
* By default, Nuxt Content extracts content from the first H1 heading and paragraphs below it.
* And uses this title and paragraph as default value for the `title` and `description` fields.
*
* Setting this option to `false` will disable this behavior.
*
* @default true
*/
contentHeading?: boolean
/**
* Register custom remark plugin to provide new feature into your markdown contents.
* Checkout: https://github.com/remarkjs/remark/blob/main/doc/plugins.md
Expand Down