https://github.com/riscv-software-src/riscv-docs-docker
A docker image for building RISC-V documentation
https://github.com/riscv-software-src/riscv-docs-docker
Last synced: 3 months ago
JSON representation
A docker image for building RISC-V documentation
- Host: GitHub
- URL: https://github.com/riscv-software-src/riscv-docs-docker
- Owner: riscv-software-src
- License: bsd-2-clause
- Created: 2021-11-25T00:12:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-15T18:17:12.000Z (over 2 years ago)
- Last Synced: 2025-01-05T02:42:56.646Z (5 months ago)
- Language: Dockerfile
- Size: 3.91 KB
- Stars: 3
- Watchers: 6
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# riscv-docs-docker
A [docker container](https://hub.docker.com/r/riscvintl/rv-docs) for building [RISC-V documentation](https://github.com/riscv/docs-templates).
This docker image is based on Ubuntu and is intended to help build RISC-V documentation, specifically tested with the [docs-templates](https://github.com/riscv/docs-templates).
## Build an image from the Dockerfile
```
$> git clone [email protected]:riscv-software-src/riscv-docs-docker.git
$> cd riscv-docs-docker
$> docker build -t riscvintl/rv-docs .
```
## Run the container
```
$> cd my/working/dir
$> docker run --rm -u 1000 -t -i -v "$(pwd):/home/dockeruser/workspace" --net=host riscvintl/rv-docs /bin/bash
```
## Build docs-templates
```
[dockeruser@rv-docs] workspace # git clone https://github.com/riscv/docs-templates.git
[dockeruser@rv-docs] workspace # cd docs-templates
[dockeruser@rv-docs] workspace # make
```
## Caveats
Tested on Ubuntu 20.04 and macOS Monterey (Intel).
Dockerfile created by an aging engineer bereft of coding acumine.