Skip to content

Commit 21bcef5

Browse files
NathanFlurryNathanFlurry
committed
docs: remove anchor links from module table
1 parent f3759b5 commit 21bcef5

2 files changed

Lines changed: 21 additions & 26 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -70,26 +70,26 @@ Bounded channels give you backpressure, `for await` gives you clean shutdown on
7070
<!-- MODULE_TABLE_START -->
7171
| Module | Rust Equivalent | Minified | Gzip |
7272
|--------|-----------------|----------|------|
73-
| [`antiox/panic`](#antioxpanic) | [`std::panic!`, `std::todo!`, `std::unreachable!`](https://doc.rust-lang.org/std/) | 273 B | 199 B |
74-
| [`antiox/sync/mpsc`](#antioxsyncmpsc) | [`tokio::sync::mpsc`](https://docs.rs/tokio/latest/tokio/sync/mpsc/) | 5.1 KB | 1.4 KB |
75-
| [`antiox/sync/oneshot`](#antioxsynconeshot) | [`tokio::sync::oneshot`](https://docs.rs/tokio/latest/tokio/sync/oneshot/) | 1.7 KB | 625 B |
76-
| [`antiox/sync/watch`](#antioxsyncwatch) | [`tokio::sync::watch`](https://docs.rs/tokio/latest/tokio/sync/watch/) | 1.7 KB | 677 B |
77-
| [`antiox/sync/broadcast`](#antioxsyncbroadcast) | [`tokio::sync::broadcast`](https://docs.rs/tokio/latest/tokio/sync/broadcast/) | 2.4 KB | 936 B |
78-
| [`antiox/sync/semaphore`](#antioxsyncsemaphore) | [`tokio::sync::Semaphore`](https://docs.rs/tokio/latest/tokio/sync/struct.Semaphore.html) | 2.0 KB | 845 B |
79-
| [`antiox/sync/notify`](#antioxsyncnotify) | [`tokio::sync::Notify`](https://docs.rs/tokio/latest/tokio/sync/struct.Notify.html) | 934 B | 466 B |
80-
| [`antiox/sync/mutex`](#antioxsyncmutex) | [`tokio::sync::Mutex`](https://docs.rs/tokio/latest/tokio/sync/struct.Mutex.html) | 1.4 KB | 606 B |
81-
| [`antiox/sync/rwlock`](#antioxsyncrwlock) | [`tokio::sync::RwLock`](https://docs.rs/tokio/latest/tokio/sync/struct.RwLock.html) | 2.2 KB | 778 B |
82-
| [`antiox/sync/barrier`](#antioxsyncbarrier) | [`tokio::sync::Barrier`](https://docs.rs/tokio/latest/tokio/sync/struct.Barrier.html) | 1.1 KB | 528 B |
83-
| [`antiox/sync/select`](#antioxsyncselect) | [`tokio::select!`](https://docs.rs/tokio/latest/tokio/macro.select.html) | 338 B | 260 B |
84-
| [`antiox/sync/once_cell`](#antioxsynconcecell) | [`tokio::sync::OnceCell`](https://docs.rs/tokio/latest/tokio/sync/struct.OnceCell.html) | 699 B | 355 B |
85-
| [`antiox/sync/cancellation_token`](#antioxsynccancellationtoken) | [`tokio_util::sync::CancellationToken`](https://docs.rs/tokio-util/latest/tokio_util/sync/struct.CancellationToken.html) | 623 B | 357 B |
86-
| [`antiox/sync/drop_guard`](#antioxsyncdropguard) | [`tokio_util::sync::DropGuard`](https://docs.rs/tokio-util/latest/tokio_util/sync/struct.DropGuard.html) | 200 B | 169 B |
87-
| [`antiox/sync/priority_channel`](#antioxsyncprioritychannel) | Priority channel | 2.6 KB | 1.0 KB |
88-
| [`antiox/task`](#antioxtask) | [`tokio::task`](https://docs.rs/tokio/latest/tokio/task/) | 2.0 KB | 932 B |
89-
| [`antiox/time`](#antioxtime) | [`tokio::time`](https://docs.rs/tokio/latest/tokio/time/) | 936 B | 530 B |
90-
| [`antiox/stream`](#antioxstream) | [`tokio_stream` / `futures::stream`](https://docs.rs/tokio-stream/latest/tokio_stream/) | 10.4 KB | 3.0 KB |
91-
| [`antiox/collections/deque`](#antioxcollectionsdeque) | [`std::collections::VecDeque`](https://doc.rust-lang.org/std/collections/struct.VecDeque.html) | 1.3 KB | 493 B |
92-
| [`antiox/collections/binary_heap`](#antioxcollectionsbinaryheap) | [`std::collections::BinaryHeap`](https://doc.rust-lang.org/std/collections/struct.BinaryHeap.html) | 994 B | 492 B |
73+
| `antiox/panic` | [`std::panic!`, `std::todo!`, `std::unreachable!`](https://doc.rust-lang.org/std/) | 273 B | 199 B |
74+
| `antiox/sync/mpsc` | [`tokio::sync::mpsc`](https://docs.rs/tokio/latest/tokio/sync/mpsc/) | 5.1 KB | 1.4 KB |
75+
| `antiox/sync/oneshot` | [`tokio::sync::oneshot`](https://docs.rs/tokio/latest/tokio/sync/oneshot/) | 1.7 KB | 625 B |
76+
| `antiox/sync/watch` | [`tokio::sync::watch`](https://docs.rs/tokio/latest/tokio/sync/watch/) | 1.7 KB | 677 B |
77+
| `antiox/sync/broadcast` | [`tokio::sync::broadcast`](https://docs.rs/tokio/latest/tokio/sync/broadcast/) | 2.4 KB | 936 B |
78+
| `antiox/sync/semaphore` | [`tokio::sync::Semaphore`](https://docs.rs/tokio/latest/tokio/sync/struct.Semaphore.html) | 2.0 KB | 845 B |
79+
| `antiox/sync/notify` | [`tokio::sync::Notify`](https://docs.rs/tokio/latest/tokio/sync/struct.Notify.html) | 934 B | 466 B |
80+
| `antiox/sync/mutex` | [`tokio::sync::Mutex`](https://docs.rs/tokio/latest/tokio/sync/struct.Mutex.html) | 1.4 KB | 606 B |
81+
| `antiox/sync/rwlock` | [`tokio::sync::RwLock`](https://docs.rs/tokio/latest/tokio/sync/struct.RwLock.html) | 2.2 KB | 778 B |
82+
| `antiox/sync/barrier` | [`tokio::sync::Barrier`](https://docs.rs/tokio/latest/tokio/sync/struct.Barrier.html) | 1.1 KB | 528 B |
83+
| `antiox/sync/select` | [`tokio::select!`](https://docs.rs/tokio/latest/tokio/macro.select.html) | 338 B | 260 B |
84+
| `antiox/sync/once_cell` | [`tokio::sync::OnceCell`](https://docs.rs/tokio/latest/tokio/sync/struct.OnceCell.html) | 699 B | 355 B |
85+
| `antiox/sync/cancellation_token` | [`tokio_util::sync::CancellationToken`](https://docs.rs/tokio-util/latest/tokio_util/sync/struct.CancellationToken.html) | 623 B | 357 B |
86+
| `antiox/sync/drop_guard` | [`tokio_util::sync::DropGuard`](https://docs.rs/tokio-util/latest/tokio_util/sync/struct.DropGuard.html) | 200 B | 169 B |
87+
| `antiox/sync/priority_channel` | Priority channel | 2.6 KB | 1.0 KB |
88+
| `antiox/task` | [`tokio::task`](https://docs.rs/tokio/latest/tokio/task/) | 2.0 KB | 932 B |
89+
| `antiox/time` | [`tokio::time`](https://docs.rs/tokio/latest/tokio/time/) | 936 B | 530 B |
90+
| `antiox/stream` | [`tokio_stream` / `futures::stream`](https://docs.rs/tokio-stream/latest/tokio_stream/) | 10.4 KB | 3.0 KB |
91+
| `antiox/collections/deque` | [`std::collections::VecDeque`](https://doc.rust-lang.org/std/collections/struct.VecDeque.html) | 1.3 KB | 493 B |
92+
| `antiox/collections/binary_heap` | [`std::collections::BinaryHeap`](https://doc.rust-lang.org/std/collections/struct.BinaryHeap.html) | 994 B | 492 B |
9393
<!-- MODULE_TABLE_END -->
9494

9595
## Documentation

‎scripts/generate-module-map.ts‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,6 @@ function formatBytes(bytes: number): string {
5252
return `${(bytes / 1024).toFixed(1)} KB`;
5353
}
5454

55-
function anchorId(name: string): string {
56-
return name.replace(/\//g, "").replace(/_/g, "");
57-
}
58-
5955
// Build table
6056
const rows: string[] = [];
6157
rows.push("| Module | Rust Equivalent | Minified | Gzip |");
@@ -69,9 +65,8 @@ for (const [name, distFile, rustEquiv, docsUrl] of modules) {
6965
const combined = Buffer.concat(bufs);
7066
const minSize = formatBytes(combined.length);
7167
const gzSize = formatBytes(gzipSync(combined).length);
72-
const anchor = anchorId(name);
7368
const equiv = docsUrl ? `[${rustEquiv}](${docsUrl})` : rustEquiv;
74-
rows.push(`| [\`${name}\`](#${anchor}) | ${equiv} | ${minSize} | ${gzSize} |`);
69+
rows.push(`| \`${name}\` | ${equiv} | ${minSize} | ${gzSize} |`);
7570
}
7671

7772
const table = rows.join("\n");

0 commit comments

Comments
 (0)