File tree 2 files changed +9
-11
lines changed 2 files changed +9
-11
lines changed Original file line number Diff line number Diff line change @@ -22,22 +22,18 @@ Check the Symfony CLI output for IP and port information where the site is runni
22
22
23
23
## Update documentation
24
24
25
- To serve the MkDocs site in ` /docs ` install dependencies:
26
-
27
- ``` sh
28
- pip install mkdocs mkdocs-material mkdocs-material-extensions
29
-
30
- Then serve the docs with live updates:
25
+ To serve the MkDocs site in ` /docs ` ensure you have installed Docker, and run the provided script
26
+ to serve the docs with live updates:
31
27
32
28
``` sh
33
29
bin/serve-docs
34
30
```
35
31
36
32
By default MkDocs binds to port 8000 and is thus accessible on http://127.0.0.1:8000 . If you get a port
37
- conflict, append the ` -a ` parameter for custom binding :
33
+ conflict, pass the bind target as a parameter :
38
34
39
35
``` shell
40
36
# Bind to localhost port 4000
41
- bin/serve-docs -a 127.0.0.1:4000
37
+ bin/serve-docs 127.0.0.1:4000
42
38
```
43
39
On pushes to the ` master ` branch the docs are automatically released to https://omines.github.io/antispam-bundle/
Original file line number Diff line number Diff line change 2
2
set -e
3
3
cd $( dirname $0 ) /../docs
4
4
5
- echo " If need be install mkdocs with 'pip install mkdocs-material mkdocs-material-extensions'"
6
- echo " You can choose a different port with 'bin/serve-docs -a 127.0.0.1:4000'"
5
+ BIND=${1:- 8000}
6
+ echo " Serving documentation on http://127.0.0.1:${BIND} "
7
+ echo " If you get an 'address already in use' error from Docker, pass another port and/or binding as parameter to this script."
7
8
echo
8
- mkdocs serve $@
9
+
10
+ docker run --rm -it -p ${BIND} :8000 -v .:/docs squidfunk/mkdocs-material
You can’t perform that action at this time.
0 commit comments