Skip to content

Commit a9c0c6e

Browse files
committed
feat: add a blog
1 parent 752f325 commit a9c0c6e

29 files changed

+790
-339
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ For more information on what Volar itself is, check out [the main repository](ht
1212

1313
Contributions of all size are welcome! If you find a typo, or want to clarify some language, or even want to add a whole new section, no matter what, we're happy to welcome your contributions.
1414

15-
If you can see what the problem is, and you know how to fix it, then definitely feel free to make a PR (pull request) with the change and contribute to this repo yourself. Alternatively, [opening an issue](https://github.com/volarjs/docs/issues/new) and letting us know about the problem is also a totally valid option.
15+
If you can see what the problem is, and you know how to fix it, then definitely feel free to make a PR (pull request) with the needed changes and contribute to this repo yourself. Alternatively, [opening an issue](https://github.com/volarjs/docs/issues/new) and letting us know about the problem is also a totally valid option.
1616

1717
### Getting the project running locally
1818

19-
If you want to run VolarJS locally, you can do so by following these steps:
19+
If you want to run the docs locally, you can do so by following these steps:
2020

2121
1. Clone the repo: `git clone https://github.com/volarjs/docs`
2222

23-
2. Install dependencies: `npm install`
23+
2. Install dependencies: `pnpm install`
2424

25-
3. Run the site locally: `npm run dev`
25+
3. Run the site locally: `pnpm run dev`
2626

2727
4. Open the site in your browser: <http://localhost:4321>
2828

astro.config.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import starlight from "@astrojs/starlight";
2-
import { defineConfig, sharpImageService } from "astro/config";
2+
import { defineConfig } from "astro/config";
33

44
// https://astro.build/config
55
export default defineConfig({
@@ -22,6 +22,11 @@ export default defineConfig({
2222
baseUrl: "https://github.com/volarjs/docs/edit/main/",
2323
},
2424
lastUpdated: true,
25+
components: {
26+
SiteTitle: "./src/components/starlight/SiteTitle.astro",
27+
TableOfContents: "./src/components/starlight/TableOfContents.astro",
28+
PageTitle: "./src/components/starlight/PageTitle.astro",
29+
},
2530
sidebar: [
2631
{
2732
label: "Core Concepts",
@@ -47,7 +52,4 @@ export default defineConfig({
4752
],
4853
}),
4954
],
50-
51-
// Process images with sharp: https://docs.astro.build/en/guides/assets/#using-sharp
52-
image: { service: sharpImageService() },
5355
});

package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111
"format": "prettier -w --cache ."
1212
},
1313
"dependencies": {
14-
"@astrojs/starlight": "^0.16.0",
15-
"@types/hast": "^3.0.3",
16-
"astro": "^4.2.3",
17-
"prettier": "^3.2.4",
14+
"@astrojs/starlight": "^0.21.1",
15+
"@types/hast": "^3.0.4",
16+
"astro": "^4.4.15",
17+
"prettier": "^3.2.5",
1818
"prettier-plugin-astro": "^0.13.0",
19-
"sharp": "^0.32.6"
19+
"sharp": "0.32.6"
2020
},
2121
"devDependencies": {
2222
"hast-util-from-html": "^2.0.1",

0 commit comments

Comments
 (0)