jmm/autodoc
1
0
Fork 0
mirror of https://github.com/ldericher/autodoc.git synced 2025-12-06 15:43:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update documentation

Browse source
This commit is contained in:
Jörn-Michael Miehe 2024-01-08 22:48:12 +01:00
parent 5ee2197f18
commit ea086a6a3a
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -8,7 +8,7 @@ In general, any file-sharing solution -- preferably on top of `docker-compose` -
## Quick Start Guide using Docker ## Quick Start Guide using Docker
The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher/autodoc) is based on [pandocker](https://hub.docker.com/r/ldericher/pandocker) providing Ubuntu's TeXlive `LaTeX` and `pandoc` in a simple box. The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher/autodoc) is based on [pandoc/extra](https://hub.docker.com/r/pandoc/extra) providing TeXlive `LaTeX` and `pandoc` in a container.
01. Install [Docker CE](https://docs.docker.com/install/) 01. Install [Docker CE](https://docs.docker.com/install/)
@ -18,7 +18,7 @@ The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher
```bash ```bash
docker run --rm -it \ docker run --rm -it \
--volume "${PWD}":/docs \ --volume "${PWD}:/docs" \
--user "$(id -u):$(id -g)" \ --user "$(id -u):$(id -g)" \
ldericher/autodoc ldericher/autodoc
``` ```
@ -58,7 +58,6 @@ services:
- documents:/opt/autodoc - documents:/opt/autodoc
autodoc: autodoc:
restart: always
image: ldericher/autodoc image: ldericher/autodoc
user: "UID:GID" user: "UID:GID"
volumes: volumes: