Skip to content

Commit

Permalink
docs: fix ToC anchors to symbol properties
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Jan 10, 2024
1 parent 7d3b414 commit ed01dcf
Show file tree
Hide file tree
Showing 14 changed files with 37 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/interfaces/AuthenticatedRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Properties

- [[experimentalUseMtlsAlias]](AuthenticatedRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalUseMtlsAlias]](AuthenticatedRequestOptions.md#experimentalusemtlsalias)
- [clientPrivateKey](AuthenticatedRequestOptions.md#clientprivatekey)

## Properties
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/Client.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Recognized Client Metadata that have an effect on the exposed functionality.
### Properties

- [client\_id](Client.md#client_id)
- [[clockSkew]](Client.md#[clockskew])
- [[clockTolerance]](Client.md#[clocktolerance])
- [[clockSkew]](Client.md#clockskew)
- [[clockTolerance]](Client.md#clocktolerance)
- [authorization\_signed\_response\_alg](Client.md#authorization_signed_response_alg)
- [client\_secret](Client.md#client_secret)
- [default\_max\_age](Client.md#default_max_age)
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/ClientCredentialsGrantRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
### Properties

- [DPoP](ClientCredentialsGrantRequestOptions.md#dpop)
- [[experimentalCustomFetch]](ClientCredentialsGrantRequestOptions.md#[experimentalcustomfetch])
- [[experimentalUseMtlsAlias]](ClientCredentialsGrantRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalCustomFetch]](ClientCredentialsGrantRequestOptions.md#experimentalcustomfetch)
- [[experimentalUseMtlsAlias]](ClientCredentialsGrantRequestOptions.md#experimentalusemtlsalias)
- [clientPrivateKey](ClientCredentialsGrantRequestOptions.md#clientprivatekey)
- [headers](ClientCredentialsGrantRequestOptions.md#headers)
- [signal](ClientCredentialsGrantRequestOptions.md#signal)
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/DeviceAuthorizationRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

### Properties

- [[experimentalCustomFetch]](DeviceAuthorizationRequestOptions.md#[experimentalcustomfetch])
- [[experimentalUseMtlsAlias]](DeviceAuthorizationRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalCustomFetch]](DeviceAuthorizationRequestOptions.md#experimentalcustomfetch)
- [[experimentalUseMtlsAlias]](DeviceAuthorizationRequestOptions.md#experimentalusemtlsalias)
- [clientPrivateKey](DeviceAuthorizationRequestOptions.md#clientprivatekey)
- [headers](DeviceAuthorizationRequestOptions.md#headers)
- [signal](DeviceAuthorizationRequestOptions.md#signal)
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/DiscoveryRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Properties

- [[experimentalCustomFetch]](DiscoveryRequestOptions.md#[experimentalcustomfetch])
- [[experimentalCustomFetch]](DiscoveryRequestOptions.md#experimentalcustomfetch)
- [algorithm](DiscoveryRequestOptions.md#algorithm)
- [headers](DiscoveryRequestOptions.md#headers)
- [signal](DiscoveryRequestOptions.md#signal)
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ExperimentalUseMTLSAliasOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Properties

- [[experimentalUseMtlsAlias]](ExperimentalUseMTLSAliasOptions.md#[experimentalusemtlsalias])
- [[experimentalUseMtlsAlias]](ExperimentalUseMTLSAliasOptions.md#experimentalusemtlsalias)

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/HttpRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### Properties

- [[experimentalCustomFetch]](HttpRequestOptions.md#[experimentalcustomfetch])
- [[experimentalCustomFetch]](HttpRequestOptions.md#experimentalcustomfetch)
- [headers](HttpRequestOptions.md#headers)
- [signal](HttpRequestOptions.md#signal)

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/IntrospectionRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

### Properties

- [[experimentalCustomFetch]](IntrospectionRequestOptions.md#[experimentalcustomfetch])
- [[experimentalUseMtlsAlias]](IntrospectionRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalCustomFetch]](IntrospectionRequestOptions.md#experimentalcustomfetch)
- [[experimentalUseMtlsAlias]](IntrospectionRequestOptions.md#experimentalusemtlsalias)
- [additionalParameters](IntrospectionRequestOptions.md#additionalparameters)
- [clientPrivateKey](IntrospectionRequestOptions.md#clientprivatekey)
- [headers](IntrospectionRequestOptions.md#headers)
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/ProtectedResourceRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
### Properties

- [DPoP](ProtectedResourceRequestOptions.md#dpop)
- [[clockSkew]](ProtectedResourceRequestOptions.md#[clockskew])
- [[experimentalCustomFetch]](ProtectedResourceRequestOptions.md#[experimentalcustomfetch])
- [[clockSkew]](ProtectedResourceRequestOptions.md#clockskew)
- [[experimentalCustomFetch]](ProtectedResourceRequestOptions.md#experimentalcustomfetch)
- [signal](ProtectedResourceRequestOptions.md#signal)

## Properties
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/PushedAuthorizationRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
### Properties

- [DPoP](PushedAuthorizationRequestOptions.md#dpop)
- [[experimentalCustomFetch]](PushedAuthorizationRequestOptions.md#[experimentalcustomfetch])
- [[experimentalUseMtlsAlias]](PushedAuthorizationRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalCustomFetch]](PushedAuthorizationRequestOptions.md#experimentalcustomfetch)
- [[experimentalUseMtlsAlias]](PushedAuthorizationRequestOptions.md#experimentalusemtlsalias)
- [clientPrivateKey](PushedAuthorizationRequestOptions.md#clientprivatekey)
- [headers](PushedAuthorizationRequestOptions.md#headers)
- [signal](PushedAuthorizationRequestOptions.md#signal)
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/RevocationRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

### Properties

- [[experimentalCustomFetch]](RevocationRequestOptions.md#[experimentalcustomfetch])
- [[experimentalUseMtlsAlias]](RevocationRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalCustomFetch]](RevocationRequestOptions.md#experimentalcustomfetch)
- [[experimentalUseMtlsAlias]](RevocationRequestOptions.md#experimentalusemtlsalias)
- [additionalParameters](RevocationRequestOptions.md#additionalparameters)
- [clientPrivateKey](RevocationRequestOptions.md#clientprivatekey)
- [headers](RevocationRequestOptions.md#headers)
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/TokenEndpointRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
### Properties

- [DPoP](TokenEndpointRequestOptions.md#dpop)
- [[experimentalCustomFetch]](TokenEndpointRequestOptions.md#[experimentalcustomfetch])
- [[experimentalUseMtlsAlias]](TokenEndpointRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalCustomFetch]](TokenEndpointRequestOptions.md#experimentalcustomfetch)
- [[experimentalUseMtlsAlias]](TokenEndpointRequestOptions.md#experimentalusemtlsalias)
- [additionalParameters](TokenEndpointRequestOptions.md#additionalparameters)
- [clientPrivateKey](TokenEndpointRequestOptions.md#clientprivatekey)
- [headers](TokenEndpointRequestOptions.md#headers)
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/UserInfoRequestOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
### Properties

- [DPoP](UserInfoRequestOptions.md#dpop)
- [[experimentalCustomFetch]](UserInfoRequestOptions.md#[experimentalcustomfetch])
- [[experimentalUseMtlsAlias]](UserInfoRequestOptions.md#[experimentalusemtlsalias])
- [[experimentalCustomFetch]](UserInfoRequestOptions.md#experimentalcustomfetch)
- [[experimentalUseMtlsAlias]](UserInfoRequestOptions.md#experimentalusemtlsalias)
- [headers](UserInfoRequestOptions.md#headers)
- [signal](UserInfoRequestOptions.md#signal)

Expand Down
16 changes: 15 additions & 1 deletion patches/typedoc-plugin-markdown+3.17.1.patch
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ index ba8e5be..6a4e1d3 100644
\ No newline at end of file
+[💗 Help the project](https://github.com/sponsors/panva)
diff --git a/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs b/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs
index ce29bc5..ef5d6f8 100755
index ce29bc5..6833f14 100755
--- a/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs
+++ b/node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs
@@ -24,18 +24,6 @@
Expand Down Expand Up @@ -192,3 +192,17 @@ index ce29bc5..ef5d6f8 100755
+{{/with}}
+
+{{/ifShowTypeHierarchy}}
\ No newline at end of file
diff --git a/node_modules/typedoc-plugin-markdown/dist/theme.js b/node_modules/typedoc-plugin-markdown/dist/theme.js
index 2f6715b..de5cf7f 100644
--- a/node_modules/typedoc-plugin-markdown/dist/theme.js
+++ b/node_modules/typedoc-plugin-markdown/dist/theme.js
@@ -145,7 +145,7 @@ class MarkdownTheme extends typedoc_1.Theme {
});
}
toAnchorRef(reflectionId) {
- return reflectionId;
+ return reflectionId.startsWith('[') && reflectionId.endsWith(']') ? reflectionId.slice(1, -1) : reflectionId;
}
getRelativeUrl(absolute) {
if (MarkdownTheme.URL_PREFIX.test(absolute)) {

0 comments on commit ed01dcf

Please sign in to comment.