Skip to content

Commit 2da95da

Browse files
bicycle1885bicycle1885
committed
format codec list using table
1 parent 67a3c5d commit 2da95da

File tree

2 files changed

+87
-17
lines changed

2 files changed

+87
-17
lines changed

‎docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ using Documenter
22
using TranscodingStreams
33

44
makedocs(
5-
format=:html,
5+
# Documenter.jl doesn't support including HTML elements.
6+
# format=:html,
67
sitename="TranscodingStreams.jl",
78
modules=[TranscodingStreams])
89

‎docs/src/index.md

Lines changed: 85 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,91 @@ lossless decompression type and `S` is a file, `TranscodingStream{C,S}` behaves
1818
like a data stream that incrementally decompresses data from the file.
1919

2020
Codecs are defined in other packages listed below:
21-
- [CodecZlib.jl](https://github.com/bicycle1885/CodecZlib.jl)
22-
- `GizipCompression` (`GzipCompressionStream`)
23-
- `GzipDecompression` (`GzipDecompressionStream`)
24-
- `ZlibCompression` (`ZlibCompressionStream`)
25-
- `ZlibDecompression` (`ZlibDecompressionStream`)
26-
- `DeflateCompression` (`DeflateCompressionStream`)
27-
- `DeflateDecompression` (`DeflateDecompressionStream`)
28-
- [CodecZstd.jl](https://github.com/bicycle1885/CodecZstd.jl)
29-
- `ZstdCompression` (`ZstdCompressionStream`)
30-
- `ZstdDecompression` (`ZstdDecompressionStream`)
31-
- [CodecBzip2.jl](https://github.com/bicycle1885/CodecBzip2.jl)
32-
- `Bzip2Compression` (`Bzip2CompressionStream`)
33-
- `Bzip2Decompression` (`Bzip2DecompressionStream`)
34-
- [CodecXz.jl](https://github.com/bicycle1885/CodecXz.jl)
35-
- `XzCompression` (`XzCompressionStream`)
36-
- `XzDecompression` (`XzDecompressionStream`)
21+
22+
<table>
23+
<tr>
24+
<th>Package</th>
25+
<th>Library</th>
26+
<th>Format</th>
27+
<th>Codec</th>
28+
<th>Stream</th>
29+
<th>Description</th>
30+
</tr>
31+
<tr>
32+
<td rowspan="6"><a href="https://github.com/bicycle1885/CodecZlib.jl">CodecZlib.jl</a></td>
33+
<td rowspan="6"><a href="http://zlib.net/">zlib</a></td>
34+
<td rowspan="2"><a href="https://tools.ietf.org/html/rfc1952">RFC1952</a></td>
35+
<td><code>GzipCompression</code></td>
36+
<td><code>GzipCompressionStream</code></td>
37+
<td>Compress data in gzip (.gz) format.</td>
38+
</tr>
39+
<tr>
40+
<td><code>GzipDecompression</code></td>
41+
<td><code>GzipDecompressionStream</code></td>
42+
<td>Decompress data in gzip (.gz) format.</td>
43+
</tr>
44+
<tr>
45+
<td rowspan="2"><a href="https://tools.ietf.org/html/rfc1950">RFC1950</a></td>
46+
<td><code>ZlibCompression</code></td>
47+
<td><code>ZlibCompressionStream</code></td>
48+
<td>Compress data in zlib format.</td>
49+
</tr>
50+
<tr>
51+
<td><code>ZlibDecompression</code></td>
52+
<td><code>ZlibDecompressionStream</code></td>
53+
<td>Decompress data in zlib format.</td>
54+
</tr>
55+
<tr>
56+
<td rowspan="2"><a href="https://tools.ietf.org/html/rfc1951">RFC1951</a></td>
57+
<td><code>DeflateCompression</code></td>
58+
<td><code>DeflateCompressionStream</code></td>
59+
<td>Compress data in zlib format.</td>
60+
</tr>
61+
<tr>
62+
<td><code>DeflateDecompression</code></td>
63+
<td><code>DeflateDecompressionStream</code></td>
64+
<td>Decompress data in zlib format.</td>
65+
</tr>
66+
<tr>
67+
<td rowspan="2"><a href="https://github.com/bicycle1885/CodecBzip2.jl">CodecBzip2.jl</a></td>
68+
<td rowspan="2"><a href="http://www.bzip.org/">bzip2</a></td>
69+
<td rowspan="2"></td>
70+
<td><code>Bzip2Compression</code></td>
71+
<td><code>Bzip2CompressionStream</code></td>
72+
<td>Compress data in bzip2 (.bz2) format.</td>
73+
</tr>
74+
<tr>
75+
<td><code>Bzip2Decompression</code></td>
76+
<td><code>Bzip2DecompressionStream</code></td>
77+
<td>Decompress data in bzip2 (.bz2) format.</td>
78+
</tr>
79+
<tr>
80+
<td rowspan="2"><a href="https://github.com/bicycle1885/CodecXz.jl">CodecXz.jl</a></td>
81+
<td rowspan="2"><a href="https://tukaani.org/xz/">xz</a></td>
82+
<td rowspan="2"><a href="https://tukaani.org/xz/xz-file-format.txt">The .xz File Format</a></td>
83+
<td><code>XzCompression</code></td>
84+
<td><code>XzCompressionStream</code></td>
85+
<td>Compress data in xz (.xz) format.</td>
86+
</tr>
87+
<tr>
88+
<td><code>XzDecompression</code></td>
89+
<td><code>XzDecompressionStream</code></td>
90+
<td>Decompress data in xz (.xz) format.</td>
91+
</tr>
92+
<tr>
93+
<td rowspan="2"><a href="https://github.com/bicycle1885/CodecZstd.jl">CodecZstd.jl</a></td>
94+
<td rowspan="2"><a href="http://facebook.github.io/zstd/">zstd</a></td>
95+
<td rowspan="2"><a href="https://github.com/facebook/zstd/blob/dev/doc/zstd_compression_format.md">Zstandard Compression Format</a></td>
96+
<td><code>ZstdCompression</code></td>
97+
<td><code>ZstdCompressionStream</code></td>
98+
<td>Compress data in zstd (.zst) format.</td>
99+
</tr>
100+
<tr>
101+
<td><code>ZstdDecompression</code></td>
102+
<td><code>ZstdDecompressionStream</code></td>
103+
<td>Decompress data in zstd (.zst) format.</td>
104+
</tr>
105+
</table>
37106

38107
By convention, codec types have a name that matches `.*(Co|Deco)mpression` and
39108
I/O types have a codec name with `Stream` suffix. An important thing is these

0 commit comments

Comments
 (0)