Skip to content

Commit 79b6345

Browse files
committed
docs: minor documentation updates
1 parent e139363 commit 79b6345

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
2525
| `repository` | Docker Hub repository in the format `<namespace>/<name>`. | `github.repository` |
2626
| `short-description` | Docker Hub repository short description. | |
2727
| `readme-filepath` | Path to the repository readme. | `./README.md` |
28-
| `enable-url-completion` | Enables completion of relative URLs to absolute ones. See also [Known Issues](#known-issues). | `false` |
28+
| `enable-url-completion` | Enables completion of relative URLs to absolute ones. See also [known Issues](#url-completion-known-issues). | `false` |
2929
| `image-extensions` | File extensions that will be treated as images. | `bmp,gif,jpg,jpeg,png,svg,webp` |
3030

3131
#### Content limits
@@ -111,23 +111,9 @@ jobs:
111111
short-description: ${{ github.event.repository.description }}
112112
```
113113

114-
## Using the Docker image independently of GitHub Actions
115-
116-
The image can be executed in other environments independently of GitHub Actions.
117-
Simply volume mount the location of the `README.md` file to the container and set environment variables as follows.
118-
119-
```bash
120-
docker run -v $PWD:/workspace \
121-
-e DOCKERHUB_USERNAME='user1' \
122-
-e DOCKERHUB_PASSWORD='xxxxx' \
123-
-e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
124-
-e README_FILEPATH='/workspace/README.md' \
125-
peterevans/dockerhub-description:3
126-
```
127-
128-
## Known Issues
114+
### URL completion known Issues
129115

130-
The completion of relative urls has some known issues:
116+
The completion of relative URLs has some known issues:
131117

132118
1. Relative markdown links in inline-code and code blocks **are also converted**:
133119

@@ -157,6 +143,20 @@ The completion of relative urls has some known issues:
157143
[toc]: #table-of-content "Table of content"
158144
```
159145

146+
## Using the Docker image independently of GitHub Actions
147+
148+
The image can be executed in other environments independently of GitHub Actions.
149+
Simply volume mount the location of the `README.md` file to the container and set environment variables as follows.
150+
151+
```bash
152+
docker run -v $PWD:/workspace \
153+
-e DOCKERHUB_USERNAME='user1' \
154+
-e DOCKERHUB_PASSWORD='xxxxx' \
155+
-e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
156+
-e README_FILEPATH='/workspace/README.md' \
157+
peterevans/dockerhub-description:3
158+
```
159+
160160
## License
161161

162162
[MIT](LICENSE)

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ inputs:
2020
Default: `./README.md`
2121
enable-url-completion:
2222
description: >
23-
Enables completion of relative urls to absolute ones
23+
Enables completion of relative URLs to absolute ones
2424
Default: `false`
2525
image-extensions:
2626
description: >
27-
Extensions of files that you be treated as images
27+
File extensions that will be treated as images
2828
Default: `bmp,gif,jpg,jpeg,png,svg,webp`
2929
runs:
3030
using: 'node16'

0 commit comments

Comments
 (0)