Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
staabm authored Jul 7, 2022
1 parent 83d38f8 commit 7cc814a
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,15 @@ Works only with Pull Requests and `md` and `mdx` files.

These are props that you can configure in the action file to customise the working.

| Props | Description | Required |
| ------------ | :--------------------------------------: | :------: |
| path | Path to place the image URL in | true |
| commitMsg | Commit message when image is added | |
| background | Background color, gradient or image url | |
| fontColor | any css supported color | |
| fontSize | the font size | |
| componentUrl | Web Component to be rendered for output. | |
| Props | Description | Required |
| ------------ | :-----------------------------------------------------: | :------: |
| path | Path to place the image URL in | true |
| commitMsg | Commit message when image is added | |
| background | Background color, gradient or image url | |
| fontColor | any css supported color | |
| fontSize | the font size | |
| componentUrl | Web Component to be rendered for output. | |
| botComments | Whether a comment with a preview image should be posted |

Frontmatter level props on a document always takes precedence over Repository level props.

Expand Down Expand Up @@ -106,6 +107,10 @@ Frontmatter level props on a document always takes precedence over Repository le
5. **I need to format the title**

The `title` prop supports markdown, feel _free_ to _use_ it.

6. **I don't want these preview image bot comments**

the `botComments` repo prop should be set to `"no"`

### I need more customisation on the output.

Expand Down

0 comments on commit 7cc814a

Please sign in to comment.