update:docs about setup with docker (#105)

dartondox · Dec 30, 2023 · c130808 · c130808
1 parent 30f2a86
commit c130808
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -7,6 +7,8 @@ on:
 
 jobs:
   deploy:
+    if: |
+      startsWith(github.event.head_commit.message, 'update:docs')
     runs-on: ubuntu-latest
 
     steps:

diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -45,3 +45,14 @@ body[data-md-color-scheme="slate"] .highlight .n {
 body[data-md-color-scheme="default"] .highlight .n {
     color: #025596;
 }
+
+body[data-md-color-scheme="default"] p code {
+    font-weight: bold !important;
+    color: #176bad !important;
+    background: #d5d5d5 !important;
+}
+
+body[data-md-color-scheme="slate"] p code {
+    font-weight: bold !important;
+    color: #176bad !important;
+}
diff --git a/docs/the-basic/installation.md b/docs/the-basic/installation.md
@@ -36,4 +36,23 @@ dox s
 or 
 
 bin/dox s
+```
+
+## Start server with docker
+
+```py
+docker-compose up -d --build
+```
+
+!!! tips
+    Ensure that setting `APP_ENV` in `.env` to `development` facilitates server operations with hot reloading during development, while configuring it as `production` ensures compilation into machine code for server deployment.
+
+## Watch the builder
+
+```py
+dart run build_runner watch 
+
+or 
+
+dox build_runner:watch
 ```