Skip to content

Commit 6384afe

Browse files
committed
Update documentation to remove "limitation" of not supporting JSON (fixed by #3).
1 parent ece50bf commit 6384afe

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This Action expects the following to be true:
1212
|Key|Description|Required|
1313
|---|---|:---:|
1414
| `personal_access_token` | A personal access token with repo scope for pushing documentation to `gh-pages` branch. See [Creating a Personal Access Token](https://help.github.com/en/enterprise/2.17/user/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) for creating the token and [Creating and Using Secrets](https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) for including secrets to be used in tandem with Github Actions. | Yes |
15-
| `config` | The path to a Jazzy yaml configuration file| No |
15+
| `config` | The path to a Jazzy yaml or json configuration file| No |
1616
| `args` | Command line arguments to be passed to Jazzy. See `jazzy --help` on your local machine for available options| No |
1717
| `version` | The Jazzy version to run. Defaults to latest | No
1818

@@ -22,7 +22,6 @@ This Action will never support the following:
2222
* Maintain commit history of the `gh-pages` branch.
2323

2424
This Action does not currently support the following:
25-
* .json configuration files
2625
* Specifying both `config` and `args`. Any `args` provided along with `config` will be ignored.
2726

2827
## Usage

0 commit comments

Comments
 (0)