Skip to content

Commit d1041a2

Browse files
yurrriqyurrriq
committed
Set up EDoc and README.md
1 parent dd42426 commit d1041a2

File tree

7 files changed

+180
-2
lines changed

7 files changed

+180
-2
lines changed

‎README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
3+
# elli_static #
4+
5+
Copyright (c) 2017 elli-lib team.
6+
7+
__Version:__ 0.0.1
8+
9+
[![Hex.pm][hex badge]][hex link]
10+
[![Hex.pm][hex downloads]][hex link]
11+
[![Travis CI][travis badge]][travis builds]
12+
[![Coverage Status][coveralls badge]][coveralls link]
13+
[![Erlang][erlang badge]][erlang downloads]
14+
[![MIT License][license badge]][LICENSE]
15+
16+
*Elli middleware to serve static files.*
17+
18+
## Build
19+
20+
```erlang
21+
rebar3 compile
22+
```
23+
24+
## License
25+
26+
`elli_static` is licensed under [The MIT License][LICENSE]
27+
28+
[travis badge]: https://travis-ci.org/elli-lib/elli_static.svg?branch=develop
29+
[travis builds]: https://travis-ci.org/elli-lib/elli_static?branch=develop
30+
[hex badge]: https://img.shields.io/hexpm/v/elli_static.svg?maxAge=2592000?style=plastic
31+
[hex link]: https://hex.pm/packages/elli_static
32+
[hex downloads]: https://img.shields.io/hexpm/dt/elli_static.svg?maxAge=2592000
33+
[coveralls badge]: https://coveralls.io/repos/github/elli-lib/elli_static/badge.svg?branch=develop
34+
[coveralls link]: https://coveralls.io/github/elli-lib/elli_static?branch=develop
35+
[erlang badge]: https://img.shields.io/badge/erlang-%E2%89%A518.0-red.svg
36+
[erlang downloads]: http://www.erlang.org/downloads
37+
[license badge]: https://img.shields.io/badge/license-MIT-blue.svg
38+
[LICENSE]: https://github.com/elli-lib/elli_static/blob/develop/LICENSE

‎doc/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
3+
# elli_static #
4+
5+
Copyright (c) 2017 elli-lib team.
6+
7+
__Version:__ 0.0.1
8+
9+
[![Hex.pm][hex badge]][hex link]
10+
[![Hex.pm][hex downloads]][hex link]
11+
[![Travis CI][travis badge]][travis builds]
12+
[![Coverage Status][coveralls badge]][coveralls link]
13+
[![Erlang][erlang badge]][erlang downloads]
14+
[![MIT License][license badge]][LICENSE]
15+
16+
*Elli middleware to serve static files.*
17+
18+
## Build
19+
20+
```erlang
21+
rebar3 compile
22+
```
23+
24+
## License
25+
26+
`elli_static` is licensed under [The MIT License][LICENSE]
27+
28+
[travis badge]: https://travis-ci.org/elli-lib/elli_static.svg?branch=develop
29+
[travis builds]: https://travis-ci.org/elli-lib/elli_static?branch=develop
30+
[hex badge]: https://img.shields.io/hexpm/v/elli_static.svg?maxAge=2592000?style=plastic
31+
[hex link]: https://hex.pm/packages/elli_static
32+
[hex downloads]: https://img.shields.io/hexpm/dt/elli_static.svg?maxAge=2592000
33+
[coveralls badge]: https://coveralls.io/repos/github/elli-lib/elli_static/badge.svg?branch=develop
34+
[coveralls link]: https://coveralls.io/github/elli-lib/elli_static?branch=develop
35+
[erlang badge]: https://img.shields.io/badge/erlang-%E2%89%A518.0-red.svg
36+
[erlang downloads]: http://www.erlang.org/downloads
37+
[license badge]: https://img.shields.io/badge/license-MIT-blue.svg
38+
[LICENSE]: https://github.com/elli-lib/elli_static/blob/develop/LICENSE

‎doc/edoc-info

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
%% encoding: UTF-8
2+
{application,elli_static}.
3+
{modules,[]}.

‎doc/erlang.png

2.06 KB
Loading

‎doc/overview.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
@copyright 2017 elli-lib team.
2+
@title elli_static
3+
@version 0.0.1
4+
5+
@doc
6+
7+
[![Hex.pm][hex badge]][hex link]
8+
[![Hex.pm][hex downloads]][hex link]
9+
[![Travis CI][travis badge]][travis builds]
10+
[![Coverage Status][coveralls badge]][coveralls link]
11+
[![Erlang][erlang badge]][erlang downloads]
12+
[![MIT License][license badge]][LICENSE]
13+
14+
*Elli middleware to serve static files.*
15+
16+
## Build
17+
18+
<pre lang="erlang"><![CDATA[rebar3 compile]]></pre>
19+
20+
21+
## License
22+
23+
`elli_static' is licensed under [The MIT License][LICENSE]
24+
25+
<!-- Named links /-->
26+
27+
[travis badge]: https://travis-ci.org/elli-lib/elli_static.svg?branch=develop
28+
[travis builds]: https://travis-ci.org/elli-lib/elli_static?branch=develop
29+
[hex badge]: https://img.shields.io/hexpm/v/elli_static.svg?maxAge=2592000?style=plastic
30+
[hex link]: https://hex.pm/packages/elli_static
31+
[hex downloads]: https://img.shields.io/hexpm/dt/elli_static.svg?maxAge=2592000
32+
[coveralls badge]: https://coveralls.io/repos/github/elli-lib/elli_static/badge.svg?branch=develop
33+
[coveralls link]: https://coveralls.io/github/elli-lib/elli_static?branch=develop
34+
[erlang badge]: https://img.shields.io/badge/erlang-%E2%89%A518.0-red.svg
35+
[erlang downloads]: http://www.erlang.org/downloads
36+
[license badge]: https://img.shields.io/badge/license-MIT-blue.svg
37+
[LICENSE]: https://github.com/elli-lib/elli_static/blob/develop/LICENSE
38+
39+
@end

‎doc/stylesheet.css

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/* standard EDoc style sheet */
2+
body {
3+
font-family: Verdana, Arial, Helvetica, sans-serif;
4+
margin-left: .25in;
5+
margin-right: .2in;
6+
margin-top: 0.2in;
7+
margin-bottom: 0.2in;
8+
color: #000000;
9+
background-color: #ffffff;
10+
}
11+
h1,h2 {
12+
margin-left: -0.2in;
13+
}
14+
div.navbar {
15+
background-color: #add8e6;
16+
padding: 0.2em;
17+
}
18+
h2.indextitle {
19+
padding: 0.4em;
20+
background-color: #add8e6;
21+
}
22+
h3.function,h3.typedecl {
23+
background-color: #add8e6;
24+
padding-left: 1em;
25+
}
26+
div.spec {
27+
margin-left: 2em;
28+
background-color: #eeeeee;
29+
}
30+
a.module {
31+
text-decoration:none
32+
}
33+
a.module:hover {
34+
background-color: #eeeeee;
35+
}
36+
ul.definitions {
37+
list-style-type: none;
38+
}
39+
ul.index {
40+
list-style-type: none;
41+
background-color: #eeeeee;
42+
}
43+
44+
/*
45+
* Minor style tweaks
46+
*/
47+
ul {
48+
list-style-type: square;
49+
}
50+
table {
51+
border-collapse: collapse;
52+
}
53+
td {
54+
padding: 3
55+
}

‎rebar.config

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,15 @@
2020
[{deps, [{edown, "0.8.1"}]},
2121
{edoc_opts,
2222
[
23+
{dir, "doc"},
2324
{doclet, edown_doclet},
24-
{doc_path, ["http://raw.github.com/elli-lib/elli/develop/doc"]},
25+
{overview, "doc/overview.md"},
26+
{doc_path,
27+
["http://raw.github.com/elli-lib/elli/develop/doc",
28+
"http://raw.github.com/elli-lib/elli_cache/develop/doc"
29+
]},
2530
{top_level_readme,
26-
{"./README.md", "https://github.com/elli-lib/elli_static", "develop"}}
31+
{"./README.md", "https://github.com/elli-lib/elli_cache", "develop"}}
2732
]}]}]}.
2833

2934
{post_hooks,

0 commit comments

Comments
 (0)