All VitePress theme code in docs/.vitepress has been rewritten. This is the main focus of the rewrite, along with the Editing Wiki Pages guide being updated.
Formatter settings have been updated. As a side effect, some markdown files have been automatically formatted.
Markdown files have been slightly altered to function with this rewrite, such as CardLinks being converted to Cards. No actual content has been changed, so this may be skipped in the review.
New Look
As part of this rewrite, the wiki's styles have been updated.
Elements like the search box and theme dropdown are now more visually consistent and colours contrast less harshly (especially in dark mode).
More elements have margins defined, reducing the need for extra spacing with <br> elements.
Before
After
Content Components
Checklists can now be created without wrapping the list in Checklist tags.
The Checklist component has been removed.
Merged functionality of the CardLink component with the Card component.
The Card component now has an optional link attribute.
The CardLink component has been removed.
The imgsrc-dark and imgsrc-light attributes have been removed from the Card component and replaced with a single image attribute.
This can either be defined as a string, or as an object defining strings for each theme.
Added a CardGrid component which should take multiple Cards as its content and will display them in a grid layout. An example of this can be seen on the new homepage.
Exposed the Tag component for usage within markdown content. This is a more convenient alternative to using Label when trying to display a tag in a specific section of a page as it comes with the tag color built-in.
<Tag name="beginner" />
The pixelated attribute of the WikiImage component is now a boolean rather than a string.
Updated the contribute-style.md page and VSCode snippets in accordance with the above changes.
Document Outline (Table of Contents)
Heading links are now displayed again.
Resolves #898
Renamed show_toc frontmatter field to show_outline.
Renamed the max_toc_level field to outline_depth and made it functional with a default of 3.
Sidebar Generation
Sidebar generation code is now in a dedicated folder (.vitepress/sidebar) rather than all in the config.ts file.
During sidebar generation, the category and tags fields of each page are now validated to ensure that each category and tag exists.
Other Fixes
The list of contributors now correctly updates when the page is changed.
The 404 page is now consistently replaced after a dead link redirect.
Resolves #133
Sidebar categories now deactivate when no longer viewing a page thats is in no section.
Resolves #629
Syntax highlighting works again.
Resolves #383
Accent colors are now defined via the data-accent-color attribute which sets the --accent-color CSS property. This attribute is used by buttons, categories and tags. Containers such as :::tip still have their own colors defined.
View Live Demo
Summary of Changed Files
docs/.vitepresshas been rewritten. This is the main focus of the rewrite, along with the Editing Wiki Pages guide being updated.New Look
As part of this rewrite, the wiki's styles have been updated.
Elements like the search box and theme dropdown are now more visually consistent and colours contrast less harshly (especially in dark mode).
More elements have margins defined, reducing the need for extra spacing with
<br>elements.Before
After
Content Components
Checklisttags.Checklistcomponent has been removed.CardLinkcomponent with theCardcomponent.Cardcomponent now has an optionallinkattribute.CardLinkcomponent has been removed.imgsrc-darkandimgsrc-lightattributes have been removed from theCardcomponent and replaced with a singleimageattribute.CardGridcomponent which should take multipleCards as its content and will display them in a grid layout. An example of this can be seen on the new homepage.Tagcomponent for usage within markdown content. This is a more convenient alternative to usingLabelwhen trying to display a tag in a specific section of a page as it comes with the tag color built-in.pixelatedattribute of theWikiImagecomponent is now a boolean rather than a string.contribute-style.mdpage and VSCode snippets in accordance with the above changes.Document Outline (Table of Contents)
show_tocfrontmatter field toshow_outline.max_toc_levelfield tooutline_depthand made it functional with a default of 3.Sidebar Generation
.vitepress/sidebar) rather than all in theconfig.tsfile.categoryandtagsfields of each page are now validated to ensure that each category and tag exists.Other Fixes
data-accent-colorattribute which sets the--accent-colorCSS property. This attribute is used by buttons, categories and tags. Containers such as:::tipstill have their own colors defined.