Skip to content
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.

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

feat: support markdown frontmatter options #1218

Merged
merged 1 commit into from
Aug 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@
},
"devDependencies": {
"@mdit-vue/plugin-component": "^0.9.2",
"@mdit-vue/plugin-frontmatter": "^0.9.2",
"@mdit-vue/plugin-toc": "^0.9.2",
"@mdit-vue/types": "^0.9.2",
"@rollup/plugin-alias": "^3.1.9",
"@rollup/plugin-commonjs": "^22.0.2",
"@rollup/plugin-json": "^4.1.0",
Expand Down Expand Up @@ -129,7 +131,6 @@
"execa": "^6.1.0",
"fast-glob": "^3.2.11",
"fs-extra": "^10.1.0",
"gray-matter": "^4.0.3",
"lint-staged": "^13.0.3",
"lru-cache": "^7.13.2",
"markdown-it": "^13.0.1",
Expand Down
15 changes: 13 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions src/node/markdown/env.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import type { MarkdownItEnv } from '@mdit-vue/types'
import { CleanUrlsMode } from '../shared'

export interface MarkdownEnv extends MarkdownItEnv {
path: string
relativePath: string
cleanUrls: CleanUrlsMode
}
2 changes: 2 additions & 0 deletions src/node/markdown/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from './env'
export * from './markdown'
8 changes: 8 additions & 0 deletions src/node/markdown/markdown.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import anchorPlugin from 'markdown-it-anchor'
import attrsPlugin from 'markdown-it-attrs'
import emojiPlugin from 'markdown-it-emoji'
import { componentPlugin } from '@mdit-vue/plugin-component'
import {
frontmatterPlugin,
type FrontmatterPluginOptions
} from '@mdit-vue/plugin-frontmatter'
import { tocPlugin, type TocPluginOptions } from '@mdit-vue/plugin-toc'
import { IThemeRegistration } from 'shiki'
import { highlight } from './plugins/highlight'
Expand Down Expand Up @@ -32,6 +36,7 @@ export interface MarkdownOptions extends MarkdownIt.Options {
allowedAttributes?: string[]
disable?: boolean
}
frontmatter?: FrontmatterPluginOptions
theme?: ThemeOptions
toc?: TocPluginOptions
externalLinks?: Record<string, string>
Expand Down Expand Up @@ -92,6 +97,9 @@ export const createMarkdownRenderer = async (
permalink: anchorPlugin.permalink.ariaHidden({}),
...options.anchor
} as anchorPlugin.AnchorOptions)
.use(frontmatterPlugin, {
...options.frontmatter
} as FrontmatterPluginOptions)
.use(tocPlugin, {
slugify,
...options.toc
Expand Down
13 changes: 10 additions & 3 deletions src/node/markdown/plugins/link.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
// 2. normalize internal links to end with `.html`

import MarkdownIt from 'markdown-it'
import { MarkdownRenderer } from '../markdown'
import type { MarkdownEnv } from '../env'
import type { MarkdownRenderer } from '../markdown'
import { URL } from 'url'
import { EXTERNAL_URL_RE, CleanUrlsMode } from '../../shared'

Expand All @@ -14,7 +15,13 @@ export const linkPlugin = (
externalAttrs: Record<string, string>,
base: string
) => {
md.renderer.rules.link_open = (tokens, idx, options, env, self) => {
md.renderer.rules.link_open = (
tokens,
idx,
options,
env: MarkdownEnv,
self
) => {
const token = tokens[idx]
const hrefIndex = token.attrIndex('href')
if (hrefIndex >= 0) {
Expand All @@ -37,7 +44,7 @@ export const linkPlugin = (
// links to files (other than html/md)
!/\.(?!html|md)\w+($|\?)/i.test(url)
) {
normalizeHref(hrefAttr, env.cleanUrl)
normalizeHref(hrefAttr, env.cleanUrls)
brc-dd marked this conversation as resolved.
Show resolved Hide resolved
}

// encode vite-specific replace strings in case they appear in URLs
Expand Down
20 changes: 11 additions & 9 deletions src/node/markdownToVue.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
import fs from 'fs'
import path from 'path'
import c from 'picocolors'
import matter from 'gray-matter'
import LRUCache from 'lru-cache'
import { PageData, HeadConfig, EXTERNAL_URL_RE, CleanUrlsMode } from './shared'
import { slash } from './utils/slash'
import { deeplyParseHeader } from './utils/parseHeader'
import { getGitTimestamp } from './utils/getGitTimestamp'
import { createMarkdownRenderer, MarkdownOptions } from './markdown/markdown'
import {
createMarkdownRenderer,
type MarkdownEnv,
type MarkdownOptions
} from './markdown'
import _debug from 'debug'

const debug = _debug('vitepress:md')
Expand Down Expand Up @@ -69,19 +72,18 @@ export async function createMarkdownToVueRenderFn(
}
})

const { content, data: frontmatter } = matter(src)

// reset state before render
md.__path = file
md.__relativePath = relativePath

const html = md.render(content, {
const env: MarkdownEnv = {
path: file,
relativePath,
cleanUrls,
frontmatter
})
cleanUrls
}
const html = md.render(src, env)
const data = md.__data
const { content = '', frontmatter = {} } = env

// validate data.links
const deadLinks: string[] = []
Expand Down Expand Up @@ -128,7 +130,7 @@ export async function createMarkdownToVueRenderFn(

const pageData: PageData = {
title: inferTitle(frontmatter, content),
titleTemplate: frontmatter.titleTemplate,
titleTemplate: frontmatter.titleTemplate as any,
description: inferDescription(frontmatter),
frontmatter,
headers: data.headers || [],
Expand Down