xref: /aosp_15_r20/external/flashrom/util/docker/flashrom.org/README.md (revision 0d6140be3aa665ecc836e8907834fcd3e3b018fc)
1# doc.coreboot.org
2 Docker container for generating and developing documentation for doc.coreboot.org
3
4**NOTE**: All paths are from the base of the coreboot git repo.
5
6### Build
7
8```sh
9  docker build --force-rm -t "doc.flashrom.org" "$PWD/util/docker/flashrom.org/"
10```
11
12### Generating production HTML
13
14```sh
15# To ensure the output directory is given the correct permissions, make sure to
16# created it before running docker the first time.
17mkdir -p "$PWD/doc/_build/"
18
19docker run -it --rm \
20           --user "$(id -u):$(id -g)" \
21           -v "$PWD/:/data-in/:ro" \
22           -v "$PWD/doc/_build/:/data-out/" \
23           doc.flashrom.org
24```
25
26### live reloaded with web server
27On the host machine, open a browser to the address http://0.0.0.0:8000
28```sh
29docker run -it --rm \
30           --net=host -v "$PWD/:/data-in/:ro" \
31           doc.flashrom.org livehtml
32```
33