Skip to content

Commit 49440d8

Browse files
committed
Migrate documentation from doc to docs directory and switch to ex_doc
1 parent cbfcf75 commit 49440d8

File tree

14 files changed

+650
-815
lines changed

14 files changed

+650
-815
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
.tool-versions
33
_build
44
deps
5+
doc
56
elvis
67
*.o
78
*.beam

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015 某文<zhongwencool@gmail.com>
3+
Copyright (c) 2015-2025 某文<zhongwencool@gmail.com>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 142 additions & 276 deletions
Large diffs are not rendered by default.

doc/docsite.erl

Lines changed: 0 additions & 100 deletions
This file was deleted.

doc/favicon.ico

-5.3 KB
Binary file not shown.

doc/overview.edoc

Lines changed: 0 additions & 284 deletions
Large diffs are not rendered by default.

doc/screen.css

Lines changed: 0 additions & 151 deletions
This file was deleted.

docs.exs

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[
2+
extras: [
3+
{"README.md", title: "Home"},
4+
"./docs/plugin.md",
5+
"./docs/changlog.md",
6+
"LICENSE"
7+
],
8+
logo: "./docs/favicon.png",
9+
authors: [
10+
"Zhongwen Deng <zhongwencool@gmail.com>"
11+
],
12+
main: "readme",
13+
source_url: "https://github.com/zhongwencool/observer_cli",
14+
homepage_url: "https://github.com/zhongwencool/obsever_cli",
15+
with_mermaid: true,
16+
before_closing_body_tag: fn
17+
:html ->
18+
"""
19+
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
20+
<script>mermaid.initialize({startOnLoad: true})</script>
21+
"""
22+
23+
_ ->
24+
""
25+
end,
26+
api_reference: false,
27+
warnings_as_errors: true,
28+
groups_for_docs: [],
29+
filter_modules: fn _, _ -> false end
30+
]

0 commit comments

Comments
 (0)