1
0
Jolene vor 2 Jahren
Ursprung
Commit
92f892dca5
3 geänderte Dateien mit 33 neuen und 17 gelöschten Zeilen
  1. 1 0
      .gitignore
  2. 29 17
      README.md
  3. 3 0
      dockerbuild/entrypoint.sh

+ 1 - 0
.gitignore

@@ -0,0 +1 @@
+markdowns/

+ 29 - 17
README.md

@@ -1,25 +1,37 @@
 
+# Intro
 
-run.sh - build docker image kinisi/vuepress and push to docker,io
+This build the image kinisi/vuepress that provides the following features :
 
-Samle docker-compose - slower at first run to initialise
+- search facility 
+- use of tabs as in demo/page2
+- use of Viz for graph as in demo/page2
+
+## Usage
+
+mkdir markdowns - folder to store all the markdowns
+
+``` yaml
+version: '3.1'
 
-```
-version: '3.3'
 services:
 
-  vuepress :
-
-    image: kinisi/vuepress
-    container_name : vuepress
-    restart : always
-    # volumes:
-    #  - ./docs:/vp/docs
-    ports :
-      - 8088:8080
-    command : [ 'npm' , 'run' , 'docs:dev' ]
-    working_dir: /vp
+  tpress :
+
+    image : kinisi/vuepress
+    ports : [ 8080:8080 ]
+    volumes :
+      - ./markdowns:/vp/docs
+    command : [ npm , run , docs:dev ]
 ```
 
-- extract the docs folder and replace with with my own
-- access at host:8088
+If the markdowns folder is empty,  the image will insert the following into the markdowns folder :
+
+- README.md
+- demo folder 
+
+
+## Building
+
+run.sh - build docker image kinisi/vuepress and push to docker,io
+

+ 3 - 0
dockerbuild/entrypoint.sh

@@ -4,11 +4,13 @@ set -x
 
 # Copy README.md to /vp/docs if it does not exists
 if [ ! -f /vp/docs/README.md ] ; then
+	echo Copy README.md to /vp/docs
 	cp /tmp/stash/README.md /vp/docs/README.md
 fi
 
 # Copy demo folder to /vp/docs if it does not exists
 if [ ! -d /vp/docs/demo ] ; then
+	echo Copy demo to /vp/docs
 	cp -r /tmp/stash/demo /vp/docs
 fi
 
@@ -17,6 +19,7 @@ if [ ! -d /vp/docs/.vuepress ] ; then
 	cp -r /tmp/stash/dot_vuepress /vp/docs/.vuepress
 fi
 
+# this is for the search
 if [ ! -f /var/tmp/init ] ; then
 	echo npm install --save-dev /vp/docs/.vuepress/plugins/pageData -loglevel verbose
 	npm install --save-dev /vp/docs/.vuepress/plugins/pageData -loglevel verbose