Skip to content

Commit

Permalink
feat: add a blog
Browse files Browse the repository at this point in the history
  • Loading branch information
Princesseuh committed Mar 9, 2024
1 parent 752f325 commit a9c0c6e
Show file tree
Hide file tree
Showing 29 changed files with 790 additions and 339 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ For more information on what Volar itself is, check out [the main repository](ht

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.

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.
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.

### Getting the project running locally

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

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

2. Install dependencies: `npm install`
2. Install dependencies: `pnpm install`

3. Run the site locally: `npm run dev`
3. Run the site locally: `pnpm run dev`

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

Expand Down
10 changes: 6 additions & 4 deletions astro.config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import starlight from "@astrojs/starlight";
import { defineConfig, sharpImageService } from "astro/config";
import { defineConfig } from "astro/config";

// https://astro.build/config
export default defineConfig({
Expand All @@ -22,6 +22,11 @@ export default defineConfig({
baseUrl: "https://github.com/volarjs/docs/edit/main/",
},
lastUpdated: true,
components: {
SiteTitle: "./src/components/starlight/SiteTitle.astro",
TableOfContents: "./src/components/starlight/TableOfContents.astro",
PageTitle: "./src/components/starlight/PageTitle.astro",
},
sidebar: [
{
label: "Core Concepts",
Expand All @@ -47,7 +52,4 @@ export default defineConfig({
],
}),
],

// Process images with sharp: https://docs.astro.build/en/guides/assets/#using-sharp
image: { service: sharpImageService() },
});
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
"format": "prettier -w --cache ."
},
"dependencies": {
"@astrojs/starlight": "^0.16.0",
"@types/hast": "^3.0.3",
"astro": "^4.2.3",
"prettier": "^3.2.4",
"@astrojs/starlight": "^0.21.1",
"@types/hast": "^3.0.4",
"astro": "^4.4.15",
"prettier": "^3.2.5",
"prettier-plugin-astro": "^0.13.0",
"sharp": "^0.32.6"
"sharp": "0.32.6"
},
"devDependencies": {
"hast-util-from-html": "^2.0.1",
Expand Down
Loading

0 comments on commit a9c0c6e

Please sign in to comment.