Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thingsym/hugo-theme-techdoc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorthingsym <thingsym@gmail.com>2021-03-08 14:33:40 +0300
committerthingsym <thingsym@gmail.com>2021-03-08 14:33:40 +0300
commit889dc8bb8dffee6dd4f00200ad1dd7c95e7ab8c4 (patch)
tree0262436f71279d10fb3a521b1397973500932710
parent02b2177c049ef91999d7ef066c4c0b6c353cebfc (diff)
docs: edit README
-rw-r--r--README.md34
1 files changed, 28 insertions, 6 deletions
diff --git a/README.md b/README.md
index 340363d..bf8c8e5 100644
--- a/README.md
+++ b/README.md
@@ -211,24 +211,46 @@ Browse site on http://localhost:1313
hugo -t hugo-theme-techdoc -d public_html
```
-## Development environment
+## Local development environment
+
+### Preview exampleSite
+
+```
+cd /path/to/dir/themes/hugo-theme-techdoc/exampleSite
+
+hugo server --themesDir ../..
+```
+
+Browse site on http://localhost:1313
+
+### Build development
```
cd /path/to/hugo-theme-techdoc
npm install
-npm run gulp:watch
+npm run gulp watch
```
-### Preview exampleSite
+## Docker development environment
-```
-cd /path/to/dir/themes/hugo-theme-techdoc/exampleSite
+### Run Docker and Preview exampleSite
-hugo server --themesDir ../..
+```
+cd /path/to/hugo-theme-techdoc
+docker-compose up -d
```
Browse site on http://localhost:1313
+### Build development
+
+```
+cd /path/to/hugo-theme-techdoc
+docker-compose up -d
+docker-compose run --rm node npm install
+docker-compose run --rm node npm run watch
+```
+
## Contribution
### Patches and Bug Fixes