Skip to content

Migrate to Vitepress#10

Draft
RichDom2185 wants to merge 12 commits into
mainfrom
vitepress
Draft

Migrate to Vitepress#10
RichDom2185 wants to merge 12 commits into
mainfrom
vitepress

Conversation

@RichDom2185
Copy link
Copy Markdown
Member

It's more modern and the default for most new sites. Has a lot of plugins too.

@RichDom2185 RichDom2185 self-assigned this May 22, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request migrates the Source Academy documentation from Docusaurus to VitePress, involving the removal of Docusaurus-specific configurations and the addition of a new VitePress setup. Key changes include updating the project structure, scripts, and dependencies in package.json, as well as refining Markdown formatting across the documentation files. Feedback was provided regarding the use of invalid or future version numbers for Node.js, TypeScript, and other dependencies, with recommendations to use current stable versions to ensure build stability.

Comment thread package.json
Comment on lines +13 to +22
"node": ">=24"
},
"packageManager": "yarn@4.15.0+sha512.07ec708ac11e2eaa4ea2b04cfbb272812f7e74a753f1595eaef4486c663a98306a30cca3e6fc40f7a0b168dcfb3a2490b6a5e0501e20fb69cc36f563dd161c53",
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1",
"@tsconfig/docusaurus": "^1.0.5",
"typescript": "^4.7.4"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"engines": {
"node": ">=16.14"
"eslint": "^9.39.4",
"oxc-minify": "^0.131.0",
"prettier": "^3.8.1",
"typescript": "^6.0.2",
"vitepress": "2.0.0-alpha.17",
"vue": "^3.5.30"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Several version numbers specified in engines, packageManager, and devDependencies appear to be invalid or refer to non-existent future versions (e.g., Node.js 24, TypeScript 6.0.2, Vue 3.5.30). Please use current stable versions to ensure the project can be built and maintained.

Suggested change
"node": ">=24"
},
"packageManager": "yarn@4.15.0+sha512.07ec708ac11e2eaa4ea2b04cfbb272812f7e74a753f1595eaef4486c663a98306a30cca3e6fc40f7a0b168dcfb3a2490b6a5e0501e20fb69cc36f563dd161c53",
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1",
"@tsconfig/docusaurus": "^1.0.5",
"typescript": "^4.7.4"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"engines": {
"node": ">=16.14"
"eslint": "^9.39.4",
"oxc-minify": "^0.131.0",
"prettier": "^3.8.1",
"typescript": "^6.0.2",
"vitepress": "2.0.0-alpha.17",
"vue": "^3.5.30"
"node": ">=22"
},
"packageManager": "yarn@4.5.3",
"devDependencies": {
"eslint": "^9.16.0",
"oxc-minify": "^0.1.0",
"prettier": "^3.4.2",
"typescript": "^5.7.2",
"vitepress": "^1.5.0",
"vue": "^3.5.13"

Comment thread .node-version
@@ -0,0 +1 @@
24.15.0
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Node.js version 24 has not been released yet. Please use a current stable version, such as the latest LTS (v22).

22.12.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant