Skip to content

Commit d47a412

Browse files
committed
fix: re-run generate-docs.js
1 parent ecf4a93 commit d47a412

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

docs/currentBranch.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ sidebar_label: currentBranch
55

66
Get the name of the branch currently pointed to by .git/HEAD
77

8-
| param | type [= default] | description |
9-
| --------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------- |
10-
| core | string = 'default' | The plugin core identifier to use for plugin injection |
11-
| fs [deprecated] | FileSystem | The filesystem containing the git repo. Overrides the fs provided by the [plugin system](./plugin_fs.md). |
12-
| dir | string | The [working tree](dir-vs-gitdir.md) directory path |
13-
| **gitdir** | string = join(dir,'.git') | The [git directory](dir-vs-gitdir.md) path |
14-
| fullname | boolean = false | Return the full path (e.g. "refs/heads/master") instead of the abbreviated form. |
8+
| param | type [= default] | description |
9+
| --------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------- |
10+
| core | string = 'default' | The plugin core identifier to use for plugin injection |
11+
| fs [deprecated] | FileSystem | The filesystem containing the git repo. Overrides the fs provided by the [plugin system](./plugin_fs.md). |
12+
| dir | string | The [working tree](dir-vs-gitdir.md) directory path |
13+
| **gitdir** | string = join(dir,'.git') | The [git directory](dir-vs-gitdir.md) path |
14+
| fullname | boolean = false | Return the full path (e.g. "refs/heads/master") instead of the abbreviated form. |
1515
| return | Promise\<(string\|undefined)\> | The name of the current branch or undefined if the HEAD is detached. |
1616

1717
Example Code:

docs/verify.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ sidebar_label: verify
55

66
Verify a signed commit or tag
77

8-
| param | type [= default] | description |
9-
| -------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
10-
| core | string = 'default' | The plugin core identifier to use for plugin injection |
11-
| fs [deprecated] | FileSystem | The filesystem containing the git repo. Overrides the fs provided by the [plugin system](./plugin_fs.md). |
12-
| dir | string | The [working tree](dir-vs-gitdir.md) directory path |
13-
| **gitdir** | string = join(dir,'.git') | The [git directory](dir-vs-gitdir.md) path |
14-
| **ref** | string | A reference to the commit or tag to verify |
15-
| **publicKeys** | string | A PGP public key in ASCII armor format. |
16-
| openpgp [deprecated] | OpenPGP | An instance of the [OpenPGP library](https://unpkg.com/[email protected]). Deprecated in favor of using a [PGP plugin](./plugin_pgp.md). |
17-
| return | Promise\<(false|Array\<string\>)\> | The value `false` or the valid key ids (in hex format) used to sign the commit. |
8+
| param | type [= default] | description |
9+
| -------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
10+
| core | string = 'default' | The plugin core identifier to use for plugin injection |
11+
| fs [deprecated] | FileSystem | The filesystem containing the git repo. Overrides the fs provided by the [plugin system](./plugin_fs.md). |
12+
| dir | string | The [working tree](dir-vs-gitdir.md) directory path |
13+
| **gitdir** | string = join(dir,'.git') | The [git directory](dir-vs-gitdir.md) path |
14+
| **ref** | string | A reference to the commit or tag to verify |
15+
| **publicKeys** | string | A PGP public key in ASCII armor format. |
16+
| openpgp [deprecated] | OpenPGP | An instance of the [OpenPGP library](https://unpkg.com/[email protected]). Deprecated in favor of using a [PGP plugin](./plugin_pgp.md). |
17+
| return | Promise\<(false\|Array\<string\>)\> | The value `false` or the valid key ids (in hex format) used to sign the commit. |
1818

1919
For now, key management is beyond the scope of isomorphic-git's PGP features.
2020
It is up to you to figure out what the commit's or tag's public key _should_ be.

0 commit comments

Comments
 (0)