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.

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

docs: update reference documentation to reflect type definition correctly #3167

Merged
merged 4 commits into from
Nov 2, 2023
Merged

docs: update reference documentation to reflect type definition correctly #3167

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1b09000
docs: `languages` should be array
abiriadev Nov 2, 2023
a7a5d6d
docs: `allowedAttributes` can accept `RegExp`
abiriadev Nov 2, 2023
9e98493
docs: `headers` can accept `boolean`s
abiriadev Nov 2, 2023
f9bd0fd
docs: `math` can accept `boolean`
abiriadev Nov 2, 2023
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
8 changes: 4 additions & 4 deletions docs/reference/site-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ interface MarkdownOptions extends MarkdownIt.Options {

// Add support for your own languages.
// https://github.com/shikijs/shiki/blob/main/docs/languages.md#supporting-your-own-languages-with-shiki
languages?: Shiki.ILanguageRegistration
languages?: Shiki.ILanguageRegistration[]

// markdown-it-anchor plugin options.
// See: https://github.com/valeriangalliat/markdown-it-anchor#usage
Expand All @@ -491,7 +491,7 @@ interface MarkdownOptions extends MarkdownIt.Options {
attrs?: {
leftDelimiter?: string
rightDelimiter?: string
allowedAttributes?: string[]
allowedAttributes?: Array<string | RegExp>
disable?: boolean
}

Expand All @@ -504,7 +504,7 @@ interface MarkdownOptions extends MarkdownIt.Options {

// @mdit-vue/plugin-headers plugin options.
// See: https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-headers#options
headers?: HeadersPluginOptions
headers?: HeadersPluginOptions | boolean

// @mdit-vue/plugin-sfc plugin options.
// See: https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-sfc#options
Expand All @@ -531,7 +531,7 @@ interface MarkdownOptions extends MarkdownIt.Options {
// You need to install `markdown-it-mathjax3` and set `math` to `true` to enable it.
// You can also pass options to `markdown-it-mathjax3` here.
// See: https://github.com/tani/markdown-it-mathjax3#customization
math?: any
math?: boolean | any

// Global custom container titles
container?: {
Expand Down