Portainer
/
portainer-docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add section regarding Visual Studio Code devcontainer to README.md

pull/79/head
Marc Hoersken 2019-10-25 21:09:13 +02:00
parent 78587413a1
commit 63813a46b0
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -14,3 +14,18 @@ $ docker run --rm -v ${PWD}/docs:/src portainer/docbuilder:latest make html
```
HTML files will be available under `docs/build/html` for preview.
## Visual Studio Code
You can also work directly inside the docker container used above via
[VS Code devcontainer](https://code.visualstudio.com/docs/remote/containers).
Please follow the getting started guide from the link above to install and
setup the required VS Code extensions. Once they are ready VS Code will
inform you that it has detected a devcontainer configuration and you can
switch your project folder into it. During startup of the devcontainer
VS Code will build the Dockerfile of this repository, mount the project
into the running container and finally open a terminal for you inside it.
Inside the devcontainer based project workspace you can then run the
pre-defined VS Code Task "Make HTML" to build the documentation.