Skip to content

feat: introduce wrapperDiv option #61

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
merged 3 commits into from
Jan 30, 2025
Merged

feat: introduce wrapperDiv option #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0a0cb5
feat: make the wrapper div optional
michaelmcandrew Jan 29, 2025
d722402
fix: set default for wrapperDiv
michaelmcandrew Jan 30, 2025
49685d7
chore: udpate docs
antfu Jan 30, 2025
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
27 changes: 15 additions & 12 deletions src/core/markdown.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ export function createMarkdown(options: ResolvedOptions) {
const md = await setupPromise

const {
wrapperDiv,
wrapperClasses,
wrapperComponent,
transforms,
Expand All @@ -116,18 +117,20 @@ export function createMarkdown(options: ResolvedOptions) {
let html = await md.renderAsync(raw, env)
const { excerpt = '', frontmatter: data = null } = env

const wrapperClassesResolved = toArray(
typeof wrapperClasses === 'function'
? wrapperClasses(id, raw)
: wrapperClasses,
)
.filter(Boolean)
.join(' ')

if (wrapperClassesResolved)
html = `<div class="${wrapperClassesResolved}">${html}</div>`
else
html = `<div>${html}</div>`
if (wrapperDiv) {
const wrapperClassesResolved = toArray(
typeof wrapperClasses === 'function'
? wrapperClasses(id, raw)
: wrapperClasses,
)
.filter(Boolean)
.join(' ')

if (wrapperClassesResolved)
html = `<div class="${wrapperClassesResolved}">${html}</div>`
else
html = `<div>${html}</div>`
}

const wrapperComponentName = typeof wrapperComponent === 'function'
? wrapperComponent(id, raw)
Expand Down
1 change: 1 addition & 0 deletions src/core/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export function resolveOptions(userOptions: Options): ResolvedOptions {
markdownItOptions: {},
markdownItUses: [],
markdownItSetup: () => {},
wrapperDiv: true,
wrapperComponent: null,
transforms: {},
vueVersion: userOptions.vueVersion || getVueVersion(),
Expand Down
9 changes: 8 additions & 1 deletion src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,13 @@ export interface Options {
*/
markdownItSetup?: (MarkdownIt: MarkdownItAsync) => void | Promise<void>

/**
* Wrap the html in a div
*
* @default true
*/
wrapperDiv?: boolean

/**
* Class names for wrapper div
*
Expand Down Expand Up @@ -199,7 +206,7 @@ export interface Options {
exclude?: FilterPattern
}

export interface ResolvedOptions extends Required<Options> {}
export interface ResolvedOptions extends Required<Options> { }

export interface MarkdownEnv extends MarkdownItEnv {
id: string
Expand Down