Skip to content

Commit 2c286d0

Browse files
evolvewithevanevolvewithevan
committed
docs: populate mdbook documentation
1 parent e23a0af commit 2c286d0

28 files changed

+969
-0
lines changed

‎docs/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book

‎docs/book.toml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[book]
2+
authors = ["GitCord Team"]
3+
language = "en"
4+
multilingual = false
5+
src = "src"
6+
title = "GitCord Documentation"
7+
8+
[output.html]
9+
git-repository-url = "https://github.com/your-username/gitcord"
10+
git-repository-icon = "fa-github"
11+
site-url = "/"
12+
git-repository-edit-url = "https://github.com/your-username/gitcord/edit/main/docs/src/"
13+
additional-css = ["custom.css"]
14+
additional-js = ["custom.js"]
15+
16+
[output.html.fold]
17+
enable = true
18+
level = 1

‎docs/custom.css‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
/* Custom styles for GitCord documentation */
2+
3+
:root {
4+
--primary-color: #5865f2;
5+
--secondary-color: #7289da;
6+
--accent-color: #99aab5;
7+
--background-color: #ffffff;
8+
--text-color: #2c2f33;
9+
--code-background: #f6f8fa;
10+
--border-color: #e1e4e8;
11+
}
12+
13+
/* Header styling */
14+
.book-header {
15+
background: linear-gradient(135deg, var(--primary-color), var(--secondary-color));
16+
border-bottom: 3px solid var(--accent-color);
17+
}
18+
19+
.book-header h1 {
20+
color: white;
21+
text-shadow: 0 2px 4px rgba(0,0,0,0.3);
22+
}
23+
24+
/* Navigation styling */
25+
.book-summary {
26+
background-color: #f8f9fa;
27+
border-right: 1px solid var(--border-color);
28+
}
29+
30+
.book-summary ul.summary li a {
31+
color: var(--text-color);
32+
border-left: 3px solid transparent;
33+
transition: all 0.3s ease;
34+
}
35+
36+
.book-summary ul.summary li a:hover {
37+
background-color: var(--primary-color);
38+
color: white;
39+
border-left-color: var(--accent-color);
40+
}
41+
42+
.book-summary ul.summary li.active > a {
43+
background-color: var(--primary-color);
44+
color: white;
45+
border-left-color: var(--accent-color);
46+
}
47+
48+
/* Code blocks */
49+
.markdown pre {
50+
background-color: var(--code-background);
51+
border: 1px solid var(--border-color);
52+
border-radius: 6px;
53+
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
54+
}
55+
56+
.markdown code {
57+
background-color: var(--code-background);
58+
color: #e83e8c;
59+
padding: 2px 4px;
60+
border-radius: 3px;
61+
font-size: 0.9em;
62+
}
63+
64+
/* YAML syntax highlighting */
65+
.hljs-string {
66+
color: #28a745;
67+
}
68+
69+
.hljs-keyword {
70+
color: #007bff;
71+
}
72+
73+
.hljs-number {
74+
color: #fd7e14;
75+
}
76+
77+
/* Buttons and interactive elements */
78+
.btn {
79+
background-color: var(--primary-color);
80+
border: none;
81+
color: white;
82+
padding: 8px 16px;
83+
border-radius: 4px;
84+
text-decoration: none;
85+
display: inline-block;
86+
transition: background-color 0.3s ease;
87+
}
88+
89+
.btn:hover {
90+
background-color: var(--secondary-color);
91+
color: white;
92+
text-decoration: none;
93+
}
94+
95+
/* Alerts and notices */
96+
.alert {
97+
padding: 12px 16px;
98+
margin: 16px 0;
99+
border-radius: 6px;
100+
border-left: 4px solid;
101+
}
102+
103+
.alert-info {
104+
background-color: #d1ecf1;
105+
border-color: #17a2b8;
106+
color: #0c5460;
107+
}
108+
109+
.alert-warning {
110+
background-color: #fff3cd;
111+
border-color: #ffc107;
112+
color: #856404;
113+
}
114+
115+
.alert-success {
116+
background-color: #d4edda;
117+
border-color: #28a745;
118+
color: #155724;
119+
}
120+
121+
.alert-danger {
122+
background-color: #f8d7da;
123+
border-color: #dc3545;
124+
color: #721c24;
125+
}
126+
127+
/* Tables */
128+
.markdown table {
129+
border-collapse: collapse;
130+
width: 100%;
131+
margin: 16px 0;
132+
}
133+
134+
.markdown table th,
135+
.markdown table td {
136+
border: 1px solid var(--border-color);
137+
padding: 8px 12px;
138+
text-align: left;
139+
}
140+
141+
.markdown table th {
142+
background-color: var(--code-background);
143+
font-weight: 600;
144+
}
145+
146+
.markdown table tr:nth-child(even) {
147+
background-color: #f8f9fa;
148+
}
149+
150+
/* Responsive design */
151+
@media (max-width: 768px) {
152+
.book-summary {
153+
position: fixed;
154+
top: 0;
155+
left: -100%;
156+
width: 80%;
157+
height: 100%;
158+
z-index: 1000;
159+
transition: left 0.3s ease;
160+
}
161+
162+
.book-summary.open {
163+
left: 0;
164+
}
165+
}
166+
167+
/* Print styles */
168+
@media print {
169+
.book-summary,
170+
.book-header {
171+
display: none;
172+
}
173+
174+
.markdown {
175+
margin: 0;
176+
padding: 0;
177+
}
178+
}

0 commit comments

Comments
 (0)