-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhance docs; include volume and port mapping for Docker/WSL2 use cases [Fixes #31] #37
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add line breaks to make sure that each line is max 120 characters long (I'll add a .editorconfig
later). This way, everyone can open the readme in any text editor without having to think about enabling line wrapping to conveniently read it.
README.md
Outdated
```shell | ||
installed> structurizr-site-generatr generate-site -w workspace.dsl | ||
|
||
docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 generate-site -w workspace.dsl |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 generate-site -w workspace.dsl | |
docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr:<version> generate-site -w workspace.dsl |
README.md
Outdated
```shell | ||
installed> structurizr-site-generatr serve -w workspace.dsl | ||
|
||
docker> docker run -it --rm -v c:/projects/c4:/var/model -p 8080:8080 ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 serve -w workspace.dsl |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docker> docker run -it --rm -v c:/projects/c4:/var/model -p 8080:8080 ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 serve -w workspace.dsl | |
docker> docker run -it --rm -v c:/projects/c4:/var/model -p 8080:8080 ghcr.io/avisi-cloud/structurizr-site-generatr:<version> serve -w workspace.dsl |
Thank you, this is a big improvement in the docs! |
My original pull request was compliant with out-the-box Prettier rules for markdown, that is no hard-coded line ends within paragraphs. However, as you specifically requested this, I've:
|
Hi @dirkgroot
Here's the documentation update that includes the points triaged via #31 .