aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Raasch <425211+janraasch@users.noreply.github.com>2024-02-20 15:47:14 +0100
committerJan Raasch <425211+janraasch@users.noreply.github.com>2024-02-20 15:47:14 +0100
commitfab37cf385a8bcab05951b8e2e851c0ecdc441fe (patch)
treedfa5610b36506199d0b76c21100db5ec8701d21a
parentea7bb396cc8c6ca8213f626fc0744a391f76f716 (diff)
downloadhugo-bearcub-fab37cf385a8bcab05951b8e2e851c0ecdc441fe.tar.gz
hugo-bearcub-fab37cf385a8bcab05951b8e2e851c0ecdc441fe.tar.bz2
Add »Development«-section on README.md
This is mostly a note to self 📝😁😇
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6c2304f..ab0a75e 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ When the user's browser is running »dark mode«, the dark color scheme will be
If you already have a Hugo site on your machine, you can simply add this theme via
-```
+```bash
git submodule add https://github.com/janraasch/hugo-bearblog.git themes/hugo-bearblog
```
@@ -48,7 +48,7 @@ The contents of the `index`-page may be changed by editing your `content/_index.
You can add **a new page** via running
-```
+```bash
hugo new my-new-page.md
```
@@ -56,7 +56,7 @@ hugo new my-new-page.md
You can add **a new blog-post** via running
-```
+```bash
hugo new blog/my-new-post.md
```
@@ -67,6 +67,13 @@ Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you
## Issues / Feedback / Contributing
Please use [GitHub issues](https://github.com/janraasch/hugo-bearblog/issues) and [Pull Requests](https://github.com/janraasch/hugo-bearblog/pulls).
+## Development
+Run the `exampleSite` locally via
+
+```bash
+hugo server --source ./exampleSite --themesDir ../..
+```
+
## Special Thanks 🎁
A special thank you goes out to [Herman](https://herman.bearblog.dev), for creating the original [ʕ•ᴥ•ʔ Bear Blog](https://bearblog.dev/).