Skip to content

Commit d67aad2

Browse files
budimanjojobudimanjojo
committed
docs: add mkdocs site (WIP)
1 parent 3230654 commit d67aad2

17 files changed

+1814
-0
lines changed

‎docs/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site/

‎docs/docs/contributing.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributing
2+
3+
Contributions are what make the open source community such an amazing place to learn, inspire, and create.
4+
Any contributions you make are **greatly appreciated**!
5+
6+
If you have a suggestion that would make this better, please fork the [repo](https://github.com/budimanjojo/talhelper) and create a pull request.
7+
You can also simply open an issue with the label "enhancement".
8+
Don't forget to give the project a star!
9+
10+
1. Fork the project
11+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
12+
3. Commit your changes (`git commit -m 'feat: add some AmazingFeature`)
13+
4. Push to the branch (`git push origin feature/AmazingFeature`)
14+
5. Open a Pull Request

‎docs/docs/css/extra.css

+288
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,288 @@
1+
.wy-nav-side, .wy-nav-top {
2+
background: #1f2335;
3+
}
4+
5+
.wy-side-nav-search {
6+
background: #1f2335;
7+
}
8+
9+
.wy-side-nav-search .wy-dropdown > a img.logo,
10+
.wy-side-nav-search > a img.logo {
11+
width: 40%;
12+
}
13+
14+
.wy-nav-top a,
15+
.wy-nav-top i,
16+
.wy-side-nav-search .wy-dropdown > a,
17+
.wy-side-nav-search > a {
18+
color: #a9b1d6;
19+
}
20+
21+
.wy-side-nav-search .wy-form input {
22+
background: #c8d3f5;
23+
color: #24283b;
24+
border-color: #1f2335;
25+
}
26+
27+
.wy-menu-vertical header, .wy-menu-vertical p.caption {
28+
color: #7aa2f7;
29+
}
30+
31+
.wy-menu-vertical a,
32+
.wy-menu-vertical li button.toctree-expand {
33+
color: #c0caf5;
34+
}
35+
36+
.wy-menu-vertical a:hover {
37+
background: none;
38+
color: #565f89;
39+
}
40+
41+
.wy-menu-vertical li.current > a,
42+
.wy-menu-vertical li.on a {
43+
background: #a9b1d6;
44+
color: #24283b;
45+
}
46+
47+
.wy-menu-vertical li.current > a:hover,
48+
.wy-menu-vertical li.current > a:hover button.l1,
49+
.wy-menu-vertical li.on a:hover {
50+
background: #a9b1d6;
51+
color: #565f89;
52+
}
53+
54+
.wy-menu-vertical li.current > a button.toctree-expand,
55+
.wy-menu-vertical li.on a button.toctree-expand {
56+
color: #24283b;
57+
}
58+
59+
.wy-menu-vertical li.toctree-l2.current > a,
60+
.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a,
61+
.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a {
62+
background: #c8d3f5;
63+
}
64+
65+
.wy-menu-vertical li.toctree-l2 a,
66+
.wy-menu-vertical li.toctree-l3 a,
67+
.wy-menu-vertical li.toctree-l4 a,
68+
.wy-menu-vertical li.toctree-l5 a,
69+
.wy-menu-vertical li.toctree-l6 a,
70+
.wy-menu-vertical li.toctree-l7 a,
71+
.wy-menu-vertical li.toctree-l8 a,
72+
.wy-menu-vertical li.toctree-l9 a,
73+
.wy-menu-vertical li.toctree-l10 a {
74+
background: #c8d3f5;
75+
color: #24283b;
76+
}
77+
78+
.wy-menu-vertical li.toctree-l2 a:hover,
79+
.wy-menu-vertical li.toctree-l3 a:hover,
80+
.wy-menu-vertical li.toctree-l4 a:hover,
81+
.wy-menu-vertical li.toctree-l5 a:hover,
82+
.wy-menu-vertical li.toctree-l6 a:hover,
83+
.wy-menu-vertical li.toctree-l7 a:hover,
84+
.wy-menu-vertical li.toctree-l8 a:hover,
85+
.wy-menu-vertical li.toctree-l9 a:hover,
86+
.wy-menu-vertical li.toctree-l10 a:hover {
87+
background: #c8d3f5;
88+
color: #565f89;
89+
}
90+
91+
.rst-versions .rst-current-version {
92+
background: #1f2335;
93+
}
94+
95+
.rst-versions .rst-current-version span a {
96+
color: #c0caf5 !important;
97+
}
98+
99+
.wy-nav-content {
100+
background: #1a1b26;
101+
max-width: none;
102+
}
103+
104+
.wy-body-for-nav {
105+
background: #1a1b26;
106+
}
107+
108+
.wy-nav-content .wy-breadcrumbs li a {
109+
color: #c0caf5;
110+
}
111+
112+
body {
113+
color: #c0caf5;
114+
}
115+
116+
h1 {
117+
color: #7aa2f7;
118+
}
119+
120+
h2 {
121+
color: #9ece6a;
122+
}
123+
124+
h3,
125+
h4,
126+
h5,
127+
h6 {
128+
color: #f7768e;
129+
}
130+
131+
.wy-nav-content a {
132+
color: #ff9e64;
133+
}
134+
135+
.wy-nav-content a:visited {
136+
color: #bb9af7;
137+
}
138+
139+
.wy-nav-content a:hover,
140+
.wy-nav-content a:focus,
141+
.wy-nav-content a:visited:hover {
142+
color: #e0af68;
143+
}
144+
145+
.rst-content div[class^="highlight"],
146+
.rst-content pre.literal-block {
147+
border: none;
148+
}
149+
150+
.rst-content table div[class^="highlight"],
151+
.rst-content table pre.literal-block {
152+
margin: 0;
153+
}
154+
155+
.rst-content table pre code {
156+
padding: 6px;
157+
}
158+
159+
.rst-content code,
160+
.rst-content pre code {
161+
background: #1a1b26;
162+
color: #a9b1d6;
163+
border: solid 1px #292e42;
164+
}
165+
166+
td, th {
167+
border: 1px solid #292e42 !important;
168+
}
169+
170+
.rst-content table.docutils thead, .rst-content table.field-list thead, .wy-table thead {
171+
color: #c0caf5;
172+
}
173+
174+
.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td, .wy-table-backed, .wy-table-odd td, .wy-table-striped tr:nth-child(2n-1) td {
175+
background: #1a1b26;
176+
}
177+
178+
.tabbed-set {
179+
position: relative;
180+
display: flex;
181+
flex-wrap: wrap;
182+
margin: 1em 0;
183+
border-radius: 0.1rem;
184+
}
185+
186+
.tabbed-set > input {
187+
display: none;
188+
}
189+
190+
.tabbed-set label {
191+
color: #c0caf5;
192+
width: auto;
193+
padding: 0.9375em 1.25em 0.78125em;
194+
font-weight: 700;
195+
white-space: nowrap;
196+
border-bottom: 0.15rem solid transparent;
197+
border-top-left-radius: 0.1rem;
198+
border-top-right-radius: 0.1rem;
199+
cursor: pointer;
200+
transition: background-color 250ms, color 250ms;
201+
}
202+
203+
.tabbed-set .tabbed-content {
204+
width: 100%;
205+
display: none;
206+
box-shadow: 0 -.05rem #ddd;
207+
padding: 24px;
208+
border: 1px solid #292e42;
209+
}
210+
211+
.tabbed-set input {
212+
position: absolute;
213+
opacity: 0;
214+
}
215+
216+
.tabbed-set input:checked:nth-child(n+1) + label {
217+
color: #f7768e;
218+
border-color: #f7768e;
219+
}
220+
221+
@media screen {
222+
.tabbed-set input:nth-child(n+1):checked + label + .tabbed-content {
223+
order: 99;
224+
display: block;
225+
}
226+
}
227+
228+
@media print {
229+
.tabbed-content {
230+
display: contents;
231+
}
232+
}
233+
234+
.rst-content .note .admonition-title,
235+
.rst-content .note .wy-alert-title,
236+
.rst-content .seealso .admonition-title,
237+
.rst-content .seealso .wy-alert-title,
238+
.rst-content .wy-alert-info.admonition-todo .admonition-title,
239+
.rst-content .wy-alert-info.admonition-todo .wy-alert-title,
240+
.rst-content .wy-alert-info.admonition .admonition-title,
241+
.rst-content .wy-alert-info.admonition .wy-alert-title,
242+
.rst-content .wy-alert-info.attention .admonition-title,
243+
.rst-content .wy-alert-info.attention .wy-alert-title,
244+
.rst-content .wy-alert-info.caution .admonition-title,
245+
.rst-content .wy-alert-info.caution .wy-alert-title,
246+
.rst-content .wy-alert-info.danger .admonition-title,
247+
.rst-content .wy-alert-info.danger .wy-alert-title,
248+
.rst-content .wy-alert-info.error .admonition-title,
249+
.rst-content .wy-alert-info.error .wy-alert-title,
250+
.rst-content .wy-alert-info.hint .admonition-title,
251+
.rst-content .wy-alert-info.hint .wy-alert-title,
252+
.rst-content .wy-alert-info.important .admonition-title,
253+
.rst-content .wy-alert-info.important .wy-alert-title,
254+
.rst-content .wy-alert-info.tip .admonition-title,
255+
.rst-content .wy-alert-info.tip .wy-alert-title,
256+
.rst-content .wy-alert-info.warning .admonition-title,
257+
.rst-content .wy-alert-info.warning .wy-alert-title,
258+
.rst-content .wy-alert.wy-alert-info .admonition-title,
259+
.wy-alert.wy-alert-info .rst-content .admonition-title,
260+
.wy-alert.wy-alert-info .wy-alert-title {
261+
background: #f7768e;
262+
}
263+
264+
.rst-content .admonition-title, .wy-alert-title {
265+
color: #1f2335;
266+
}
267+
268+
.rst-content .note,
269+
.rst-content .seealso,
270+
.rst-content .wy-alert-info.admonition,
271+
.rst-content .wy-alert-info.admonition-todo,
272+
.rst-content .wy-alert-info.attention,
273+
.rst-content .wy-alert-info.caution,
274+
.rst-content .wy-alert-info.danger,
275+
.rst-content .wy-alert-info.error,
276+
.rst-content .wy-alert-info.hint,
277+
.rst-content .wy-alert-info.important,
278+
.rst-content .wy-alert-info.tip,
279+
.rst-content .wy-alert-info.warning,
280+
.wy-alert.wy-alert-info {
281+
background: #1f2335;
282+
}
283+
284+
.rst-content .admonition code {
285+
color: #c0caf5;
286+
background: #1f2335;
287+
border: 1px solid #292e42;
288+
}

‎docs/docs/css/highlight.css

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
pre { line-height: 125%; }
2+
td.linenos .normal { color: #2f334d; background-color: #1a1b26; padding-left: 5px; padding-right: 5px; }
3+
span.linenos { color: #2f334d; background-color: #1a1b26; padding-left: 5px; padding-right: 5px; }
4+
td.linenos .special { color: #c0caf5; background-color: #2f334d; padding-left: 5px; padding-right: 5px; }
5+
span.linenos.special { color: #c0caf5; background-color: #2f334d; padding-left: 5px; padding-right: 5px; }
6+
.highlight .hll { background-color: #2f334d }
7+
.highlight { background: #1a1b26; color: #c0caf5 }
8+
.highlight .c { color: #8b949e; font-style: italic } /* Comment */
9+
.highlight .err { color: #f85149 } /* Error */
10+
.highlight .esc { color: #c0caf5 } /* Escape */
11+
.highlight .g { color: #c0caf5 } /* Generic */
12+
.highlight .k { color: #db4b4b } /* Keyword */
13+
.highlight .l { color: #89ddff } /* Literal */
14+
.highlight .n { color: #c0caf5 } /* Name */
15+
.highlight .o { color: #db4b4b; font-weight: bold } /* Operator */
16+
.highlight .x { color: #c0caf5 } /* Other */
17+
.highlight .p { color: #c0caf5 } /* Punctuation */
18+
.highlight .ch { color: #8b949e; font-style: italic } /* Comment.Hashbang */
19+
.highlight .cm { color: #8b949e; font-style: italic } /* Comment.Multiline */
20+
.highlight .cp { color: #8b949e; font-weight: bold; font-style: italic } /* Comment.Preproc */
21+
.highlight .cpf { color: #8b949e; font-style: italic } /* Comment.PreprocFile */
22+
.highlight .c1 { color: #8b949e; font-style: italic } /* Comment.Single */
23+
.highlight .cs { color: #8b949e; font-weight: bold; font-style: italic } /* Comment.Special */
24+
.highlight .gd { color: #ffa198; background-color: #490202 } /* Generic.Deleted */
25+
.highlight .ge { color: #c0caf5; font-style: italic } /* Generic.Emph */
26+
.highlight .gr { color: #ffa198 } /* Generic.Error */
27+
.highlight .gh { color: #7aa2f7; font-weight: bold } /* Generic.Heading */
28+
.highlight .gi { color: #56d364; background-color: #0f5323 } /* Generic.Inserted */
29+
.highlight .go { color: #8b949e } /* Generic.Output */
30+
.highlight .gp { color: #8b949e } /* Generic.Prompt */
31+
.highlight .gs { color: #c0caf5; font-weight: bold } /* Generic.Strong */
32+
.highlight .gu { color: #7aa2f7 } /* Generic.Subheading */
33+
.highlight .gt { color: #db4b4b } /* Generic.Traceback */
34+
.highlight .g-Underline { color: #c0caf5; text-decoration: underline } /* Generic.Underline */
35+
.highlight .kc { color: #7aa2f7 } /* Keyword.Constant */
36+
.highlight .kd { color: #db4b4b } /* Keyword.Declaration */
37+
.highlight .kn { color: #db4b4b } /* Keyword.Namespace */
38+
.highlight .kp { color: #7aa2f7 } /* Keyword.Pseudo */
39+
.highlight .kr { color: #db4b4b } /* Keyword.Reserved */
40+
.highlight .kt { color: #db4b4b } /* Keyword.Type */
41+
.highlight .ld { color: #7aa2f7 } /* Literal.Date */
42+
.highlight .m { color: #89ddff } /* Literal.Number */
43+
.highlight .s { color: #89ddff } /* Literal.String */
44+
.highlight .na { color: #c0caf5 } /* Name.Attribute */
45+
.highlight .nb { color: #c0caf5 } /* Name.Builtin */
46+
.highlight .nc { color: #f0883e; font-weight: bold } /* Name.Class */
47+
.highlight .no { color: #7aa2f7; font-weight: bold } /* Name.Constant */
48+
.highlight .nd { color: #d2a8ff; font-weight: bold } /* Name.Decorator */
49+
.highlight .ni { color: #ffa657 } /* Name.Entity */
50+
.highlight .ne { color: #f0883e; font-weight: bold } /* Name.Exception */
51+
.highlight .nf { color: #d2a8ff; font-weight: bold } /* Name.Function */
52+
.highlight .nl { color: #7aa2f7; font-weight: bold } /* Name.Label */
53+
.highlight .nn { color: #db4b4b } /* Name.Namespace */
54+
.highlight .nx { color: #c0caf5 } /* Name.Other */
55+
.highlight .py { color: #7aa2f7 } /* Name.Property */
56+
.highlight .nt { color: #9ece6a } /* Name.Tag */
57+
.highlight .nv { color: #7aa2f7 } /* Name.Variable */
58+
.highlight .ow { color: #db4b4b; font-weight: bold } /* Operator.Word */
59+
.highlight .pm { color: #c0caf5 } /* Punctuation.Marker */
60+
.highlight .w { color: #2f334d } /* Text.Whitespace */
61+
.highlight .mb { color: #89ddff } /* Literal.Number.Bin */
62+
.highlight .mf { color: #89ddff } /* Literal.Number.Float */
63+
.highlight .mh { color: #89ddff } /* Literal.Number.Hex */
64+
.highlight .mi { color: #89ddff } /* Literal.Number.Integer */
65+
.highlight .mo { color: #89ddff } /* Literal.Number.Oct */
66+
.highlight .sa { color: #7aa2f7 } /* Literal.String.Affix */
67+
.highlight .sb { color: #89ddff } /* Literal.String.Backtick */
68+
.highlight .sc { color: #89ddff } /* Literal.String.Char */
69+
.highlight .dl { color: #7aa2f7 } /* Literal.String.Delimiter */
70+
.highlight .sd { color: #89ddff } /* Literal.String.Doc */
71+
.highlight .s2 { color: #89ddff } /* Literal.String.Double */
72+
.highlight .se { color: #7aa2f7 } /* Literal.String.Escape */
73+
.highlight .sh { color: #7aa2f7 } /* Literal.String.Heredoc */
74+
.highlight .si { color: #89ddff } /* Literal.String.Interpol */
75+
.highlight .sx { color: #89ddff } /* Literal.String.Other */
76+
.highlight .sr { color: #7aa2f7 } /* Literal.String.Regex */
77+
.highlight .s1 { color: #89ddff } /* Literal.String.Single */
78+
.highlight .ss { color: #89ddff } /* Literal.String.Symbol */
79+
.highlight .bp { color: #c0caf5 } /* Name.Builtin.Pseudo */
80+
.highlight .fm { color: #d2a8ff; font-weight: bold } /* Name.Function.Magic */
81+
.highlight .vc { color: #7aa2f7 } /* Name.Variable.Class */
82+
.highlight .vg { color: #7aa2f7 } /* Name.Variable.Global */
83+
.highlight .vi { color: #7aa2f7 } /* Name.Variable.Instance */
84+
.highlight .vm { color: #7aa2f7 } /* Name.Variable.Magic */
85+
.highlight .il { color: #89ddff } /* Literal.Number.Integer.Long */

0 commit comments

Comments
 (0)