Skip to content

Commit 6d0030b

Browse files
committed
doc: import names in headings are not code blocks
1 parent 9e30190 commit 6d0030b

File tree

3 files changed

+26
-20
lines changed

3 files changed

+26
-20
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `@exodus/bytes`
1+
# @exodus/bytes
22

33
[![](https://flat.badgen.net/npm/v/@exodus/bytes)](https://npmjs.org/package/@exodus/bytes)
44
[![](https://flat.badgen.net/github/release/ExodusOSS/bytes?icon=github)](https://github.com/ExodusOSS/bytes/releases)
@@ -100,7 +100,7 @@ See [the list of encodings](https://encoding.spec.whatwg.org/#names-and-labels).
100100

101101
## API
102102

103-
### `@exodus/bytes/utf8.js`
103+
### @exodus/bytes/utf8.js
104104

105105
UTF-8 encoding/decoding
106106

@@ -166,7 +166,7 @@ Prefer using strict throwing methods for cryptography applications._
166166
This is similar to `new TextDecoder('utf-8', { ignoreBOM: true }).decode(arr)`,
167167
but works on all engines.
168168

169-
### `@exodus/bytes/utf16.js`
169+
### @exodus/bytes/utf16.js
170170

171171
UTF-16 encoding/decoding
172172

@@ -216,7 +216,7 @@ Prefer using strict throwing methods for cryptography applications._
216216

217217
Throws on non-even byte length.
218218

219-
### `@exodus/bytes/single-byte.js`
219+
### @exodus/bytes/single-byte.js
220220

221221
Decode / encode the legacy single-byte encodings according to the
222222
[Encoding standard](https://encoding.spec.whatwg.org/)
@@ -337,7 +337,7 @@ Same as:
337337
const windows1252fromString = createSinglebyteEncoder('windows-1252', { mode: 'fatal' })
338338
```
339339

340-
### `@exodus/bytes/multi-byte.js`
340+
### @exodus/bytes/multi-byte.js
341341

342342
Decode / encode the legacy multi-byte encodings according to the
343343
[Encoding standard](https://encoding.spec.whatwg.org/)
@@ -379,7 +379,7 @@ Returns a function `encode(string)` that encodes a string to bytes.
379379
In `'fatal'` mode (default), will throw on non well-formed strings or any codepoints which could
380380
not be encoded in the target encoding.
381381

382-
### `@exodus/bytes/bigint.js`
382+
### @exodus/bytes/bigint.js
383383

384384
Convert between BigInt and Uint8Array
385385

@@ -401,7 +401,7 @@ Convert a Uint8Array or Buffer to a BigInt
401401

402402
The bytes are interpreted as a big-endian unsigned integer.
403403

404-
### `@exodus/bytes/hex.js`
404+
### @exodus/bytes/hex.js
405405

406406
Implements Base16 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
407407
(no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
@@ -420,7 +420,7 @@ Unlike `Buffer.from()`, throws on invalid input
420420

421421
Encode a `Uint8Array` to a lowercase hex string
422422

423-
### `@exodus/bytes/base64.js`
423+
### @exodus/bytes/base64.js
424424

425425
Implements base64 and base64url from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
426426
(no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
@@ -457,7 +457,7 @@ Encode a `Uint8Array` to a base64 string (RFC 4648)
457457

458458
Encode a `Uint8Array` to a base64url string (RFC 4648)
459459

460-
### `@exodus/bytes/base32.js`
460+
### @exodus/bytes/base32.js
461461

462462
Implements base32 and base32hex from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
463463
(no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
@@ -487,7 +487,7 @@ Encode a `Uint8Array` to a base32 string (RFC 4648)
487487

488488
Encode a `Uint8Array` to a base32hex string (RFC 4648)
489489

490-
### `@exodus/bytes/bech32.js`
490+
### @exodus/bytes/bech32.js
491491

492492
Implements bech32 and bech32m from
493493
[BIP-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki#specification)
@@ -521,7 +521,7 @@ Decode a bech32m string to bytes
521521

522522
Encode bytes to a bech32m string
523523

524-
### `@exodus/bytes/base58.js`
524+
### @exodus/bytes/base58.js
525525

526526
Implements [base58](https://www.ietf.org/archive/id/draft-msporny-base58-03.txt) encoding.
527527

@@ -556,7 +556,7 @@ Encode a `Uint8Array` to a base58 string using XRP alphabet
556556

557557
Uses the XRP variant base58 alphabet
558558

559-
### `@exodus/bytes/base58check.js`
559+
### @exodus/bytes/base58check.js
560560

561561
Implements [base58check](https://en.bitcoin.it/wiki/Base58Check_encoding) encoding.
562562

@@ -596,7 +596,7 @@ Uses double SHA-256 for checksum calculation
596596

597597
Create a base58check encoder/decoder with custom hash functions
598598

599-
### `@exodus/bytes/wif.js`
599+
### @exodus/bytes/wif.js
600600

601601
Wallet Import Format (WIF) encoding and decoding.
602602

@@ -635,7 +635,7 @@ Encode WIF data to a WIF string
635635

636636
Encode WIF data to a WIF string (synchronous)
637637

638-
### `@exodus/bytes/array.js`
638+
### @exodus/bytes/array.js
639639

640640
TypedArray utils and conversions.
641641

@@ -650,7 +650,7 @@ Create a view of a TypedArray in the specified format (`'uint8'` or `'buffer'`)
650650
> [!IMPORTANT]
651651
> Does not copy data, returns a view on the same underlying buffer
652652
653-
### `@exodus/bytes/encoding.js`
653+
### @exodus/bytes/encoding.js
654654

655655
Implements the [Encoding standard](https://encoding.spec.whatwg.org/):
656656
[TextDecoder](https://encoding.spec.whatwg.org/#interface-textdecoder),
@@ -761,7 +761,7 @@ only expects lowercased encoding name:
761761
new TextDecoder(getBOMEncoding(input) ?? fallbackEncoding).decode(input)
762762
```
763763
764-
### `@exodus/bytes/encoding-lite.js`
764+
### @exodus/bytes/encoding-lite.js
765765
766766
The exact same exports as `@exodus/bytes/encoding.js` are also exported as
767767
`@exodus/bytes/encoding-lite.js`, with the difference that the lite version does not load
@@ -820,7 +820,7 @@ true
820820
'%'
821821
```
822822
823-
### `@exodus/bytes/encoding-browser.js`
823+
### @exodus/bytes/encoding-browser.js
824824
825825
Same as `@exodus/bytes/encoding.js`, but in browsers instead of polyfilling just uses whatever the
826826
browser provides, drastically reducing the bundle size (to less than 2 KiB gzipped).
@@ -841,7 +841,7 @@ do not provide sufficiently complete / non-buggy `TextDecoder` APIs.
841841
> but they are fixing them and the expected update window is short.\
842842
> If you want to circumvent browser bugs, use full `@exodus/bytes/encoding.js` import.
843843
844-
### `@exodus/bytes/whatwg.js`
844+
### @exodus/bytes/whatwg.js
845845
846846
WHATWG helpers
847847

theme/styles/panels.css

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@
1212
display: none !important;
1313
}
1414

15-
.tsd-accordion-summary,
16-
.tsd-panel > h1.tsd-anchor-link:has(code) {
15+
.page-menu li:has(> a:first-child > span:first-child:empty) {
16+
display: none;
17+
}
18+
19+
.tsd-accordion-summary {
1720
display: none;
1821
}
1922

typedoc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
"navigation": {
66
"includeFolders": false
77
},
8+
"headings": {
9+
"readme": false
10+
},
811
"outputs": [
912
{
1013
"name": "html",

0 commit comments

Comments
 (0)