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

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

Merged
merged 4 commits into from
Nov 2, 2023

Conversation

abiriadev
Copy link
Contributor

Hi Vitepress team. Thank you for this wonderful project!

I found some differences between Site Config reference documentation and its actual type definition while reading the document, so I made changes to reflect the differences.

For example:

Document:

languages?: Shiki.ILanguageRegistration

Actual type:
languages?: ILanguageRegistration[]

Document:

allowedAttributes?: string[]

Actual type:
allowedAttributes?: Array<string | RegExp>

Document:

headers?: HeadersPluginOptions

Actual type:
headers?: HeadersPluginOptions | boolean

Document:


Actual type:
math?: boolean | any

Regards.

@brc-dd brc-dd merged commit f188da0 into vuejs:main Nov 2, 2023
6 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants