Skip to content

Commit

Permalink
Add description to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jcbhmr authored Jun 9, 2023
1 parent efcec93 commit 699f1da
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ replacing every `-` (dash) character with a space. Name your files accordingly.
The `Home.md` file will automatically become the homepage, not `README.md`. This
is specific to GitHub wikis.

### Options
### Inputs

- **`strategy`:** Select from `clone` or `init` to determine which method to use
to push changes to the GitHub wiki. `clone` will clone the `.wiki.git` repo
Expand Down Expand Up @@ -116,7 +116,7 @@ is specific to GitHub wikis.
not push to the remote wiki. The default is `false`. This is useful for
testing.

#### `strategy:` option
#### `strategy:` input

There are some specific usecases where using `strategy: init` might be better
than the default `strategy: clone`.
Expand All @@ -132,6 +132,12 @@ than the default `strategy: clone`.
push using `strategy: init` on each wiki deployment and none of that pesky
history will be saved.

### Outputs

- **`wiki_url`:** The HTTP URL that points to the deployed repository's wiki
tab. This is essentially the concatenation of `${{ github.server_url }}`,
`${{ github.repository }}`, and the `/wiki` page.

### Preprocessing

You may wish to strip the `[link](page.md)` `.md` suffix from your links to make
Expand Down

0 comments on commit 699f1da

Please sign in to comment.