From cf2f36d23292f744c466c05634a7950a3e450a0e Mon Sep 17 00:00:00 2001
From: Spedon <70063177+Sped0n@users.noreply.github.com>
Date: Sun, 21 Jan 2024 21:33:20 +0800
Subject: [PATCH] blind commit (#249)
---
doc/getStarted.md | 46 ++++++++++++++++++++++------------------------
1 file changed, 22 insertions(+), 24 deletions(-)
diff --git a/doc/getStarted.md b/doc/getStarted.md
index cb6ac16..2fbe7cc 100644
--- a/doc/getStarted.md
+++ b/doc/getStarted.md
@@ -36,9 +36,9 @@ 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
```
-> ⚠️⚠️⚠️
+> ⚠️⚠️⚠️
>
-> Please refer to the config section for the following content.
+> Please refer to the config section for the following content.
### Module (recommended)
@@ -69,9 +69,9 @@ If you want to upgrade the theme, just run:
hugo mod get -u
```
-> ⚠️⚠️⚠️
+> ⚠️⚠️⚠️
>
-> Please refer to the config section for the following content.
+> Please refer to the config section for the following content.
## Content Management
@@ -164,8 +164,9 @@ path = "github.com/Sped0n/bridget"
```
- If you have installation with Git
- - `replacement`: replace the path after the arrow(`../..`) with the location of your local theme file (⚠️⚠️⚠️**relative path only**, example: `themes/bridget`)
- - `path`: no change
+
+ - `replacement`: replace the path after the arrow(`../..`) with the location of your local theme file (⚠️⚠️⚠️**relative path only**, example: `themes/bridget`)
+ - `path`: no change
- If you have installation with Module, **remove the `replacements` configuration**.
@@ -184,8 +185,6 @@ Detailed description in the comments.
> For users who have installation with module, please always set this option to `true`, unless you know what you are doing.
>
> Or you might get the error related to `node_modules/swiper/swiper.scss`.
->
-
### `sitemap.toml`
@@ -193,25 +192,24 @@ https://gohugo.io/templates/sitemap-template/#configuration
## Customization (AKA for developer)
-> Before heading to this section, please make sure you have **installation with Git**.
+> Before heading to this section, please make sure you have **installation with Git**.
-### Option 1: *it just works* way
+### Option 1: _it just works_ way
-> If you want to modify js/ts file, please use option 2.
+> If you want to modify js/ts file, please use option 2.
-1. Use hugo create a site and move the bridget theme into the theme directory.
-2. Run `npm install` in the bridget theme root dir, not your hugo site root dir.
-3. After the command is done, copy the `node_modules` dir from bridget theme root dir to your hugo site root dir.
-4. In your hugo site root dir, write/modify configuration files according to your needs, remember to set `bundled` option to `false`, so hugo will not use prebuilt css file.
-5. Run `hugo server` in your hugo site root dir, and you are good to go.
+1. Use hugo create a site and move the bridget theme into the theme directory.
+2. Run `npm install` in the bridget theme root dir, not your hugo site root dir.
+3. After the command is done, copy the `node_modules` dir from bridget theme root dir to your hugo site root dir.
+4. In your hugo site root dir, write/modify configuration files according to your needs, remember to set `bundled` option to `false`, so hugo will not use prebuilt css file.
+5. Run `hugo server` in your hugo site root dir, and you are good to go.
### Option 2: recommended way
-1. Use hugo create a site and move the bridget theme into the theme directory.
-2. Run `npm install` in the bridget theme root dir, not your hugo site root dir.
-3. Run `npm run dev` in the bridget theme root dir, we will use content in exampleSite to debug.
-4. Make your customization.
-5. After modification, run `npm run build` in the bridget theme root dir to build artifacts.
-6. In your hugo site root dir, write/modify configuration files according to your needs, remember to set `bundled` option to `true`, so hugo will use the artifacts you built in step 5.
-7. Run `hugo server` in your hugo site root dir, and you are good to go.
-
+1. Use hugo create a site and move the bridget theme into the theme directory.
+2. Run `npm install` in the bridget theme root dir, not your hugo site root dir.
+3. Run `npm run dev` in the bridget theme root dir, we will use content in exampleSite to debug.
+4. Make your customization.
+5. After modification, run `npm run build` in the bridget theme root dir to build artifacts.
+6. In your hugo site root dir, write/modify configuration files according to your needs, remember to set `bundled` option to `true`, so hugo will use the artifacts you built in step 5.
+7. Run `hugo server` in your hugo site root dir, and you are good to go.