Skip to content

Commit

Permalink
docs: minor documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
peter-evans committed Mar 5, 2023
1 parent e139363 commit 79b6345
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
| `repository` | Docker Hub repository in the format `<namespace>/<name>`. | `github.repository` |
| `short-description` | Docker Hub repository short description. | |
| `readme-filepath` | Path to the repository readme. | `./README.md` |
| `enable-url-completion` | Enables completion of relative URLs to absolute ones. See also [Known Issues](#known-issues). | `false` |
| `enable-url-completion` | Enables completion of relative URLs to absolute ones. See also [known Issues](#url-completion-known-issues). | `false` |
| `image-extensions` | File extensions that will be treated as images. | `bmp,gif,jpg,jpeg,png,svg,webp` |

#### Content limits
Expand Down Expand Up @@ -111,23 +111,9 @@ jobs:
short-description: ${{ github.event.repository.description }}
```

## Using the Docker image independently of GitHub Actions

The image can be executed in other environments independently of GitHub Actions.
Simply volume mount the location of the `README.md` file to the container and set environment variables as follows.

```bash
docker run -v $PWD:/workspace \
-e DOCKERHUB_USERNAME='user1' \
-e DOCKERHUB_PASSWORD='xxxxx' \
-e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
-e README_FILEPATH='/workspace/README.md' \
peterevans/dockerhub-description:3
```

## Known Issues
### URL completion known Issues

The completion of relative urls has some known issues:
The completion of relative URLs has some known issues:

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

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

## Using the Docker image independently of GitHub Actions

The image can be executed in other environments independently of GitHub Actions.
Simply volume mount the location of the `README.md` file to the container and set environment variables as follows.

```bash
docker run -v $PWD:/workspace \
-e DOCKERHUB_USERNAME='user1' \
-e DOCKERHUB_PASSWORD='xxxxx' \
-e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
-e README_FILEPATH='/workspace/README.md' \
peterevans/dockerhub-description:3
```

## License

[MIT](LICENSE)
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ inputs:
Default: `./README.md`
enable-url-completion:
description: >
Enables completion of relative urls to absolute ones
Enables completion of relative URLs to absolute ones
Default: `false`
image-extensions:
description: >
Extensions of files that you be treated as images
File extensions that will be treated as images
Default: `bmp,gif,jpg,jpeg,png,svg,webp`
runs:
using: 'node16'
Expand Down

0 comments on commit 79b6345

Please sign in to comment.