summaryrefslogtreecommitdiff
path: root/util/docker/doc.coreboot.org/README.md
blob: d5d483eeba569d800252c026bb98f054f416230b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# doc.coreboot.org
 Docker container for generating and developing documentation for doc.coreboot.org

**NOTE**: All paths are from the base of the coreboot git repo.

### Build

```sh
  docker build --force-rm -t "doc.coreboot.org" "$PWD/util/docker/doc.coreboot.org/"
```

### Generating production HTML

```sh
# To ensure the output directory is given the correct permissions, make sure to
# created it before running docker the first time.
mkdir -p "$PWD/Documentation/_build/"

docker run -it --rm \
           --user "$(id -u):$(id -g)" \
           -v "$PWD/:/data-in/:ro" \
           -v "$PWD/Documentation/_build/:/data-out/" \
           doc.coreboot.org
```

### live reloaded with web server
On the host machine, open a browser to the address http://0.0.0.0:8000
```sh
docker run -it --rm \
           --net=host -v "$PWD/:/data-in/:ro" \
           doc.coreboot.org livehtml
```