Update README.md
This commit is contained in:
43
README.md
43
README.md
@@ -1,23 +1,26 @@
|
|||||||
## requirements
|
## requirements
|
||||||
|
|
||||||
`pandoc` utility must be installed
|
* Docker
|
||||||
|
|
||||||
- Debian Bookworm:
|
## up and running
|
||||||
|
|
||||||
$ apt-get update && apt-get install -y pandoc
|
### build container image
|
||||||
|
|
||||||
## start default openresty
|
|
||||||
|
|
||||||
1. Run `docker run --rm -it --init -w /opt -v $PWD:/opt -p 80:80 openresty/openresty:1.27.1.2-0-bookworm-buildpack`
|
|
||||||
2. Visit `localhost` in web browser.
|
|
||||||
|
|
||||||
## start a custom site
|
|
||||||
|
|
||||||
### build docker image
|
|
||||||
|
|
||||||
$ make image-build
|
$ make image-build
|
||||||
|
|
||||||
### rebuild an existing docker image
|
### build site
|
||||||
|
|
||||||
|
$ make build
|
||||||
|
|
||||||
|
### start dev server
|
||||||
|
|
||||||
|
$ make serve
|
||||||
|
|
||||||
|
Visit `localhost:8080` in web browser
|
||||||
|
|
||||||
|
## getting around
|
||||||
|
|
||||||
|
### rebuild the container image
|
||||||
|
|
||||||
$ make image-rm image-build
|
$ make image-rm image-build
|
||||||
|
|
||||||
@@ -27,9 +30,11 @@
|
|||||||
|
|
||||||
### add an index page
|
### add an index page
|
||||||
|
|
||||||
|
#### create the file
|
||||||
|
|
||||||
$ docker run --rm -w /opt/app -v $PWD:/opt/app miti.sh sitegen page /opt/app index
|
$ docker run --rm -w /opt/app -v $PWD:/opt/app miti.sh sitegen page /opt/app index
|
||||||
|
|
||||||
### add to `site.moon`
|
#### add to `site.moon`
|
||||||
|
|
||||||
add "index.md"
|
add "index.md"
|
||||||
|
|
||||||
@@ -52,20 +57,10 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
### build site
|
|
||||||
|
|
||||||
$ make build
|
|
||||||
|
|
||||||
### build a single file
|
### build a single file
|
||||||
|
|
||||||
$ make build file=index.html
|
$ make build file=index.html
|
||||||
|
|
||||||
### start dev server
|
|
||||||
|
|
||||||
$ make serve
|
|
||||||
|
|
||||||
Visit `localhost:8080` in web browser
|
|
||||||
|
|
||||||
### start a shell
|
### start a shell
|
||||||
|
|
||||||
$ make shell
|
$ make shell
|
||||||
|
|||||||
Reference in New Issue
Block a user