docs: update reference documentation to reflect type definition correctly #3167
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
vitepress/docs/reference/site-config.md
Line 483 in 7dbeac6
Actual type:
vitepress/src/node/markdown/markdown.ts
Line 54 in 7dbeac6
Document:
vitepress/docs/reference/site-config.md
Line 494 in 7dbeac6
Actual type:
vitepress/src/node/markdown/markdown.ts
Line 46 in 7dbeac6
Document:
vitepress/docs/reference/site-config.md
Line 507 in 7dbeac6
Actual type:
vitepress/src/node/markdown/markdown.ts
Line 51 in 7dbeac6
Document:
vitepress/docs/reference/site-config.md
Line 534 in 7dbeac6
Actual type:
vitepress/src/node/markdown/markdown.ts
Line 59 in 7dbeac6
Regards.