minor update (#195)

* refactor: update package.json dependencies and build tools

* feat: bump up geist font version

* refactor: non-nullable-type-assertion-style bypass

* chore: bump up version in package.json

* docs: update get started doc

* styles: prettier format

.eslintrc.json

@@ -22,6 +22,7 @@
     "arrow-body-style": "off",
     "prefer-arrow-callback": "off",
     "import/no-cycle": "error",
+    "@typescript-eslint/non-nullable-type-assertion-style": "off",
     "sort-imports": [
       "error",
       {

assets/scss/_core/_font.scss

@@ -1,6 +1,8 @@
 @font-face {
   font-family: 'Geist';
-  src: url('/lib/fonts/GeistVF.woff2') format('woff2');
+  src:
+    url('/lib/fonts/GeistVF.woff2') format('woff2 supports variations'),
+    url('/lib/fonts/GeistVF.woff2') format('woff2-variations');
   font-weight: 400;
   font-style: normal;
   font-display: swap;

doc/getStarted.md

@@ -36,6 +36,8 @@ If you are already using Git for your site, you can add the theme as a submodule
 git submodule add https://github.com/Sped0n/bridget themes/bridget
 ```
 
+After cloning/downloading theme files to the directory, if you want to customize the theme, please run `pnpm install` or `npm install` first.
+
 ### Module (recommended)
 
 > If you want to modify the theme, use Git installation instead.
@@ -155,16 +157,20 @@ replacements = "github.com/Sped0n/bridget -> ../.."
 path = "github.com/Sped0n/bridget"
 ```
 
-- If you want to <u>modify the theme</u> or you have <u>installation with Git</u>, please keep the `replacements` configuration and change the path after the arrow to the location of your local theme file.
-- If you have <u>installation with Module</u>, remove the `replacements` configuration.
+- If you want to <u>modify the theme</u> or you have <u>installation with Git</u>, please **keep the `replacements` configuration** and change the path after the arrow to the location of your local theme file (relative path only).
+- If you have <u>installation with Module</u>, **remove the `replacements` configuration**.
 
 ### `markup.toml`
 
 **DO NOT TOUCH THIS**
 
 ### `params.toml`
 
-There is a detailed description in the comments.
+Detailed description in the comments.
+
+> ⚠️⚠️⚠️
+>
+> Only thing that you need to pay **extra attention** is the [`bundled`](https://github.com/Sped0n/bridget/blob/1e2f1fadde9c16989eef1ab771f2ac8463dec5a4/exampleSite/config/_default/params.toml#L6) option, please read the corresponding doc and set it as your need.
 
 ### `sitemap.toml`
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bridget",
-  "version": "v0.0.3",
+  "version": "v0.0.4",
   "description": "bridget theme source file",
   "packageManager": "[email protected]",
   "private": true,
@@ -37,9 +37,6 @@
   },
   "homepage": "https://github.com/Sped0n/bridget#readme",
   "devDependencies": {
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.5",
     "@typescript-eslint/eslint-plugin": "^6.14.0",
     "@typescript-eslint/parser": "^6.14.0",
     "eslint": "^8.55.0",
@@ -55,11 +52,14 @@
     "prettier": "3.1.1",
     "prettier-plugin-go-template": "^0.0.15",
     "prettier-plugin-organize-imports": "^3.2.4",
-    "rollup": "^4.9.0",
     "typescript": "^5.3.3"
   },
   "dependencies": {
     "gsap": "^3.12.3",
-    "swiper": "^11.0.5"
+    "swiper": "^11.0.5",
+    "rollup": "^4.9.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.5"
   }
 }