Skip to content

Commit dab0722

Browse files
committed
use Documenter's HTML generator
1 parent 3240eb2 commit dab0722

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

docs/make.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ using TranscodingStreams
33

44
makedocs(
55
# Documenter.jl doesn't support including HTML elements.
6-
# format=:html,
6+
format=:html,
77
sitename="TranscodingStreams.jl",
8-
modules=[TranscodingStreams])
8+
modules=[TranscodingStreams],
9+
assets=["assets/custom.css"])
910

1011
deploydocs(
1112
repo="github.com/bicycle1885/TranscodingStreams.jl.git",

docs/src/assets/custom.css

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
h1 {
2+
font-size: 2.0em;
3+
}
4+
5+
h2 {
6+
font-size: 1.8em;
7+
margin-top: 40px;
8+
border-bottom: 1px solid #eeeeee;
9+
}
10+
11+
table {
12+
width: 125%;
13+
font-size: 13px;
14+
}

docs/src/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ like a data stream that incrementally decompresses data from the file.
1919

2020
Codecs are defined in other packages listed below:
2121

22+
```@raw html
2223
<table>
2324
<tr>
2425
<th>Package</th>
@@ -103,6 +104,7 @@ Codecs are defined in other packages listed below:
103104
<td>Decompress data in zstd (.zst) format.</td>
104105
</tr>
105106
</table>
107+
```
106108

107109
Install packages you need by calling `Pkg.add(<package name>)` in a Julia
108110
session. For example, if you want to read gzip-compressed files, call
@@ -237,6 +239,11 @@ transcode(codec::Codec, data::Vector{UInt8})
237239
TranscodingStreams.TOKEN_END
238240
```
239241

242+
```@docs
243+
TranscodingStreams.CodecIdentity.Identity
244+
TranscodingStreams.CodecIdentity.IdentityStream
245+
```
246+
240247

241248
Defining a new codec
242249
--------------------

0 commit comments

Comments
 (0)