Skip to content

Commit f7619e2

Browse files
fredrikekrefredrikekre
authored
Add some more content and basic structure. (#2)
1 parent daff120 commit f7619e2

18 files changed

+298
-3
lines changed

‎Makefile‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
default: serve
2+
3+
build:
4+
julia --project make.jl
5+
6+
instantiate:
7+
julia --project -e 'using Pkg; Pkg.instantiate()'
8+
9+
serve: instantiate
10+
julia --project -e 'using LiveServer; LiveServer.servedocs(; foldername=pwd(), host="0.0.0.0", port=8080)'
11+
12+
.PHONY: build instantiate serve

‎Manifest.toml‎

Lines changed: 191 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
# This file is machine-generated - editing it directly is not advised
22

3+
[[AbstractTrees]]
4+
git-tree-sha1 = "03e0550477d86222521d254b741d470ba17ea0b5"
5+
uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
6+
version = "0.3.4"
7+
8+
[[ArgTools]]
9+
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
10+
11+
[[Artifacts]]
12+
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
13+
314
[[Base64]]
415
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
516

17+
[[CodecZlib]]
18+
deps = ["TranscodingStreams", "Zlib_jll"]
19+
git-tree-sha1 = "ded953804d019afa9a3f98981d99b33e3db7b6da"
20+
uuid = "944b1d66-785c-5afd-91f1-9de20f533193"
21+
version = "0.7.0"
22+
23+
[[Crayons]]
24+
git-tree-sha1 = "3f71217b538d7aaee0b69ab47d9b7724ca8afa0d"
25+
uuid = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"
26+
version = "4.0.4"
27+
628
[[Dates]]
729
deps = ["Printf"]
830
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
@@ -15,16 +37,37 @@ version = "0.8.5"
1537

1638
[[Documenter]]
1739
deps = ["Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
18-
git-tree-sha1 = "621850838b3e74dd6dd047b5432d2e976877104e"
40+
git-tree-sha1 = "5626820ef21a7787b20b9084c90205bdc4103673"
41+
repo-rev = "fe/non-versioned-docs"
42+
repo-url = "https://github.com/JuliaDocs/Documenter.jl.git"
1943
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
2044
version = "0.27.2"
2145

46+
[[Downloads]]
47+
deps = ["ArgTools", "LibCURL", "NetworkOptions"]
48+
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
49+
50+
[[FileWatching]]
51+
uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
52+
53+
[[HTTP]]
54+
deps = ["Base64", "Dates", "IniFile", "MbedTLS", "NetworkOptions", "Sockets", "URIs"]
55+
git-tree-sha1 = "86ed84701fbfd1142c9786f8e53c595ff5a4def9"
56+
uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3"
57+
version = "0.9.10"
58+
2259
[[IOCapture]]
2360
deps = ["Logging", "Random"]
2461
git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
2562
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
2663
version = "0.2.2"
2764

65+
[[IniFile]]
66+
deps = ["Test"]
67+
git-tree-sha1 = "098e4d2c533924c921f9f9847274f2ad89e018b8"
68+
uuid = "83e8ac13-25f8-5344-8a64-a9f2b223428f"
69+
version = "0.5.0"
70+
2871
[[InteractiveUtils]]
2972
deps = ["Markdown"]
3073
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
@@ -35,20 +78,98 @@ git-tree-sha1 = "81690084b6198a2e1da36fcfda16eeca9f9f24e4"
3578
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
3679
version = "0.21.1"
3780

81+
[[JSON3]]
82+
deps = ["Dates", "Mmap", "Parsers", "StructTypes", "UUIDs"]
83+
git-tree-sha1 = "a61b471557f4cf73bc1047aef9c6aa941d115320"
84+
uuid = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
85+
version = "1.8.2"
86+
87+
[[LeftChildRightSiblingTrees]]
88+
deps = ["AbstractTrees"]
89+
git-tree-sha1 = "71be1eb5ad19cb4f61fa8c73395c0338fd092ae0"
90+
uuid = "1d6d02ad-be62-4b6b-8a6d-2f90e265016e"
91+
version = "0.1.2"
92+
93+
[[LibCURL]]
94+
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
95+
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
96+
97+
[[LibCURL_jll]]
98+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
99+
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
100+
38101
[[LibGit2]]
39102
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
40103
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
41104

105+
[[LibSSH2_jll]]
106+
deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
107+
uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
108+
109+
[[Libdl]]
110+
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
111+
112+
[[LiveServer]]
113+
deps = ["Crayons", "FileWatching", "HTTP", "Pkg", "Sockets", "Test"]
114+
git-tree-sha1 = "4db4abb8b7d8dadff178b8311e540c86dffcf97d"
115+
uuid = "16fef848-5104-11e9-1b77-fb7a48bbb589"
116+
version = "0.6.6"
117+
118+
[[LogCompose]]
119+
deps = ["Logging", "Pkg"]
120+
git-tree-sha1 = "31bb42ff38e278c579be35741680a602196ffb3b"
121+
uuid = "8416b438-731e-11ea-2421-05f642269042"
122+
version = "0.2.1"
123+
124+
[[LogRoller]]
125+
deps = ["CodecZlib", "Dates", "JSON", "Logging"]
126+
git-tree-sha1 = "93e808ce285f26cc9fd88c891f123dec6599c597"
127+
uuid = "c41e01d8-14e5-11ea-185b-e7eabed7be4b"
128+
version = "0.4.2"
129+
42130
[[Logging]]
43131
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
44132

133+
[[Logging2]]
134+
deps = ["Logging"]
135+
git-tree-sha1 = "a325e8ad45ab9282b3e9cdbc2a0b1ea8b870daa5"
136+
uuid = "18cd0bd4-3461-488c-9dae-1a490b172243"
137+
version = "0.1.0"
138+
139+
[[LoggingExtras]]
140+
deps = ["Dates", "Logging"]
141+
git-tree-sha1 = "dfeda1c1130990428720de0024d4516b1902ce98"
142+
uuid = "e6f89c97-d47a-5376-807f-9c37f3926c36"
143+
version = "0.4.7"
144+
145+
[[LokiLogger]]
146+
deps = ["HTTP", "JSON3", "Logging", "StructTypes", "URIs"]
147+
git-tree-sha1 = "d412abc34fad95ca2b7d6db8c932561dc2648377"
148+
repo-rev = "master"
149+
repo-url = "https://github.com/JuliaLogging/LokiLogger.jl.git"
150+
uuid = "51d429d1-9683-4c89-86d7-889f440454ef"
151+
version = "1.0.0"
152+
45153
[[Markdown]]
46154
deps = ["Base64"]
47155
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
48156

157+
[[MbedTLS]]
158+
deps = ["Dates", "MbedTLS_jll", "Random", "Sockets"]
159+
git-tree-sha1 = "1c38e51c3d08ef2278062ebceade0e46cefc96fe"
160+
uuid = "739be429-bea8-5141-9913-cc70e7f3736d"
161+
version = "1.0.3"
162+
163+
[[MbedTLS_jll]]
164+
deps = ["Artifacts", "Libdl"]
165+
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
166+
49167
[[Mmap]]
50168
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
51169

170+
[[MozillaCACerts_jll]]
171+
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
172+
52173
[[NetworkOptions]]
53174
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
54175

@@ -58,10 +179,20 @@ git-tree-sha1 = "c8abc88faa3f7a3950832ac5d6e690881590d6dc"
58179
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
59180
version = "1.1.0"
60181

182+
[[Pkg]]
183+
deps = ["Artifacts", "Dates", "Downloads", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
184+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
185+
61186
[[Printf]]
62187
deps = ["Unicode"]
63188
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
64189

190+
[[ProgressLogging]]
191+
deps = ["Logging", "SHA", "UUIDs"]
192+
git-tree-sha1 = "80d919dee55b9c50e8d9e2da5eeafff3fe58b539"
193+
uuid = "33c8b6b6-d38a-422a-b730-caa89a2f386c"
194+
version = "0.1.4"
195+
65196
[[REPL]]
66197
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
67198
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
@@ -79,9 +210,68 @@ uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
79210
[[Sockets]]
80211
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
81212

213+
[[StructTypes]]
214+
deps = ["Dates", "UUIDs"]
215+
git-tree-sha1 = "e36adc471280e8b346ea24c5c87ba0571204be7a"
216+
uuid = "856f2bd8-1eba-4b0a-8007-ebc267875bd4"
217+
version = "1.7.2"
218+
219+
[[SyslogLogging]]
220+
deps = ["Logging", "Sockets", "Syslogs"]
221+
git-tree-sha1 = "14faba6fd7a559c0597c03a4e242d1c0440272a4"
222+
uuid = "0c4b0c42-68ec-11ea-3bc9-e7fb6e00ea0f"
223+
version = "0.1.1"
224+
225+
[[Syslogs]]
226+
deps = ["Printf", "Sockets"]
227+
git-tree-sha1 = "46badfcc7c6e74535cc7d833a91f4ac4f805f86d"
228+
uuid = "cea106d9-e007-5e6c-ad93-58fe2094e9c4"
229+
version = "0.3.0"
230+
231+
[[TOML]]
232+
deps = ["Dates"]
233+
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
234+
235+
[[Tar]]
236+
deps = ["ArgTools", "SHA"]
237+
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
238+
239+
[[TerminalLoggers]]
240+
deps = ["LeftChildRightSiblingTrees", "Logging", "Markdown", "Printf", "ProgressLogging", "UUIDs"]
241+
git-tree-sha1 = "e185a19bb9172f0cf5bc71233fab92a46f7ae154"
242+
uuid = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"
243+
version = "0.1.3"
244+
82245
[[Test]]
83246
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
84247
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
85248

249+
[[TranscodingStreams]]
250+
deps = ["Random", "Test"]
251+
git-tree-sha1 = "7c53c35547de1c5b9d46a4797cf6d8253807108c"
252+
uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
253+
version = "0.9.5"
254+
255+
[[URIs]]
256+
git-tree-sha1 = "97bbe755a53fe859669cd907f2d96aee8d2c1355"
257+
uuid = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
258+
version = "1.3.0"
259+
260+
[[UUIDs]]
261+
deps = ["Random", "SHA"]
262+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
263+
86264
[[Unicode]]
87265
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
266+
267+
[[Zlib_jll]]
268+
deps = ["Libdl"]
269+
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
270+
271+
[[nghttp2_jll]]
272+
deps = ["Artifacts", "Libdl"]
273+
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
274+
275+
[[p7zip_jll]]
276+
deps = ["Artifacts", "Libdl"]
277+
uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"

‎Project.toml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
4+
LogCompose = "8416b438-731e-11ea-2421-05f642269042"
5+
LogRoller = "c41e01d8-14e5-11ea-185b-e7eabed7be4b"
6+
Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
7+
Logging2 = "18cd0bd4-3461-488c-9dae-1a490b172243"
8+
LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
9+
LokiLogger = "51d429d1-9683-4c89-86d7-889f440454ef"
10+
ProgressLogging = "33c8b6b6-d38a-422a-b730-caa89a2f386c"
11+
SyslogLogging = "0c4b0c42-68ec-11ea-3bc9-e7fb6e00ea0f"
12+
TerminalLoggers = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"

‎README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# julialogging.github.io
22

3-
JuliaLogging organization home page
3+
JuliaLogging organization home page: [julialogging.github.io](https://julialogging.github.io).
4+
5+
6+
### Making changes
7+
8+
To make changes to the page, clone the repo and run `make serve` from the repository root.
9+
This will launch a local webserver at [http://localhost:8080](http://localhost:8080) which
10+
you can open in a browser. When you make changes to the source files the page is
11+
automatically rebuilt and the browser automatically refreshed.

‎make.jl‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,35 @@
11
using Documenter
2+
import LoggingExtras, LokiLogger, ProgressLogging, TerminalLoggers,
3+
SyslogLogging, LogRoller, LogCompose, Logging, Logging2
24

35
# Build the docs
46
makedocs(
57
sitename = "JuliaLogging",
68
pages = [
79
"Home" => "index.md",
10+
"How-to guides" => [
11+
"how-to/enable-debug.md",
12+
"how-to/log-to-file.md",
13+
],
14+
"Reference" => [
15+
"logging.md",
16+
"loggingextras.md",
17+
"terminalloggers.md",
18+
"progresslogging.md",
19+
"lokilogger.md",
20+
"logroller.md",
21+
"logcompose.md",
22+
"sysloglogging.md",
23+
"logging2.md",
24+
],
825
],
926
format = Documenter.HTML(
27+
assets = ["assets/julialogging.css"],
1028
),
1129
)
1230

1331
deploydocs(
32+
versions = nothing,
33+
push_preview = true,
1434
repo = "github.com/JuliaLogging/julialogging.github.io.git",
1535
)

‎src/assets/julialogging.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
pre, code {
2+
font-variant-ligatures: no-contextual;
3+
}

‎src/how-to/enable-debug.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# How to enable `@debug` messages
2+
3+
To be written...

‎src/how-to/log-to-file.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# How to log to a file
2+
3+
To be written...

‎src/index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,3 @@ abstractions from the
4848

4949
* [`LogCompose.jl`](https://github.com/JuliaLogging/LogCompose.jl) provides
5050
declarative logger configuration and an associated `.toml` file format.
51-

‎src/logcompose.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# LogCompose.jl
2+
3+
```@autodocs
4+
Modules = [LogCompose]
5+
```

0 commit comments

Comments
 (0)