Skip to content

Commit 7125e28

Browse files
byerlikayabyerlikaya
committed
Create modern professional documentation site with Bootstrap 5, custom CSS, and interactive JavaScript
1 parent e4b2cd0 commit 7125e28

File tree

3 files changed

+768
-283
lines changed

3 files changed

+768
-283
lines changed

‎docs/_layouts/default.html‎

Lines changed: 135 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
11
<!DOCTYPE html>
2-
<html lang="{{ site.lang | default: 'en' }}">
2+
<html lang="en">
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1">
66
<title>{% if page.title %}{{ page.title }} - {% endif %}{{ site.title }}</title>
77
<meta name="description" content="{{ page.description | default: site.description }}">
88

9-
<!-- Just the Docs CSS -->
10-
<link rel="stylesheet" href="https://unpkg.com/just-the-docs@0.7.3/dist/just-the-docs.min.css">
9+
<!-- Bootstrap 5 CSS -->
10+
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
11+
12+
<!-- Font Awesome Icons -->
13+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
14+
15+
<!-- Google Fonts -->
16+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap" rel="stylesheet">
17+
18+
<!-- Custom CSS -->
19+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/style.css">
1120

1221
<!-- Favicon -->
1322
<link rel="icon" type="image/x-icon" href="/favicon.ico">
@@ -17,60 +26,142 @@
1726
<meta property="og:description" content="{{ page.description | default: site.description }}">
1827
<meta property="og:type" content="website">
1928
<meta property="og:url" content="{{ site.url }}{{ page.url }}">
20-
21-
<!-- Twitter Card -->
22-
<meta name="twitter:card" content="summary">
23-
<meta name="twitter:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}">
24-
<meta name="twitter:description" content="{{ page.description | default: site.description }}">
2529
</head>
2630
<body>
27-
<div class="page-wrap">
28-
<div class="side-bar">
29-
<div class="site-header">
30-
<a href="{{ site.baseurl }}/" class="site-title lh-tight">
31-
{{ site.title }}
32-
</a>
33-
</div>
34-
<nav class="site-nav">
35-
<ul class="nav-list">
36-
<li class="nav-list-item">
37-
<a href="{{ site.baseurl }}/" class="nav-list-link">Home</a>
31+
<!-- Navigation -->
32+
<nav class="navbar navbar-expand-lg navbar-dark fixed-top">
33+
<div class="container">
34+
<a class="navbar-brand" href="{{ site.baseurl }}/">
35+
<i class="fas fa-brain me-2"></i>
36+
<span class="brand-text">SmartRAG</span>
37+
</a>
38+
39+
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav">
40+
<span class="navbar-toggler-icon"></span>
41+
</button>
42+
43+
<div class="collapse navbar-collapse" id="navbarNav">
44+
<ul class="navbar-nav ms-auto">
45+
<li class="nav-item">
46+
<a class="nav-link" href="{{ site.baseurl }}/"><i class="fas fa-home me-1"></i>Home</a>
47+
</li>
48+
<li class="nav-item">
49+
<a class="nav-link" href="{{ site.baseurl }}/getting-started"><i class="fas fa-rocket me-1"></i>Getting Started</a>
3850
</li>
39-
<li class="nav-list-item">
40-
<a href="{{ site.baseurl }}/getting-started" class="nav-list-link">Getting Started</a>
51+
<li class="nav-item">
52+
<a class="nav-link" href="{{ site.baseurl }}/configuration"><i class="fas fa-cog me-1"></i>Configuration</a>
4153
</li>
42-
<li class="nav-list-item">
43-
<a href="{{ site.baseurl }}/configuration" class="nav-list-link">Configuration</a>
54+
<li class="nav-item">
55+
<a class="nav-link" href="{{ site.baseurl }}/api-reference"><i class="fas fa-code me-1"></i>API Reference</a>
4456
</li>
45-
<li class="nav-list-item">
46-
<a href="{{ site.baseurl }}/api-reference" class="nav-list-link">API Reference</a>
57+
<li class="nav-item">
58+
<a class="nav-link" href="{{ site.baseurl }}/examples"><i class="fas fa-lightbulb me-1"></i>Examples</a>
4759
</li>
48-
<li class="nav-list-item">
49-
<a href="{{ site.baseurl }}/troubleshooting" class="nav-list-link">Troubleshooting</a>
60+
<li class="nav-item">
61+
<a class="nav-link" href="{{ site.baseurl }}/troubleshooting"><i class="fas fa-tools me-1"></i>Troubleshooting</a>
5062
</li>
5163
</ul>
52-
</nav>
64+
</div>
5365
</div>
54-
55-
<main class="main-content" id="main-content" role="main">
56-
<div class="page">
57-
<header class="page-header">
58-
<div class="page-header-content">
59-
<h1 class="page-title">{{ page.title }}</h1>
60-
{% if page.description %}
61-
<p class="page-description">{{ page.description }}</p>
62-
{% endif %}
66+
</nav>
67+
68+
<!-- Main Content -->
69+
<main class="main-content">
70+
<div class="container-fluid">
71+
<div class="row">
72+
<!-- Sidebar -->
73+
<div class="col-lg-3 col-xl-2 sidebar">
74+
<div class="sidebar-content">
75+
<div class="sidebar-header">
76+
<h5><i class="fas fa-book me-2"></i>Documentation</h5>
77+
</div>
78+
<nav class="sidebar-nav">
79+
<ul class="nav flex-column">
80+
<li class="nav-item">
81+
<a class="nav-link" href="{{ site.baseurl }}/">
82+
<i class="fas fa-home me-2"></i>Home
83+
</a>
84+
</li>
85+
<li class="nav-item">
86+
<a class="nav-link" href="{{ site.baseurl }}/getting-started">
87+
<i class="fas fa-rocket me-2"></i>Getting Started
88+
</a>
89+
</li>
90+
<li class="nav-item">
91+
<a class="nav-link" href="{{ site.baseurl }}/configuration">
92+
<i class="fas fa-cog me-2"></i>Configuration
93+
</a>
94+
</li>
95+
<li class="nav-item">
96+
<a class="nav-link" href="{{ site.baseurl }}/api-reference">
97+
<i class="fas fa-code me-2"></i>API Reference
98+
</a>
99+
</li>
100+
<li class="nav-item">
101+
<a class="nav-link" href="{{ site.baseurl }}/examples">
102+
<i class="fas fa-lightbulb me-2"></i>Examples
103+
</a>
104+
</li>
105+
<li class="nav-item">
106+
<a class="nav-link" href="{{ site.baseurl }}/troubleshooting">
107+
<i class="fas fa-tools me-2"></i>Troubleshooting
108+
</a>
109+
</li>
110+
</ul>
111+
</nav>
63112
</div>
64-
</header>
113+
</div>
65114

66-
<div class="page-content">
67-
{{ content }}
115+
<!-- Content Area -->
116+
<div class="col-lg-9 col-xl-10 content-area">
117+
<div class="content-wrapper">
118+
<div class="page-header">
119+
<h1 class="page-title">{{ page.title }}</h1>
120+
{% if page.description %}
121+
<p class="page-description">{{ page.description }}</p>
122+
{% endif %}
123+
</div>
124+
125+
<div class="page-content">
126+
{{ content }}
127+
</div>
128+
</div>
68129
</div>
69130
</div>
70-
</main>
71-
</div>
131+
</div>
132+
</main>
133+
134+
<!-- Footer -->
135+
<footer class="footer">
136+
<div class="container">
137+
<div class="row">
138+
<div class="col-md-6">
139+
<p class="mb-0">&copy; 2025 SmartRAG. Built with ❤️ by Barış Yerlikaya</p>
140+
</div>
141+
<div class="col-md-6 text-md-end">
142+
<a href="https://github.com/byerlikaya/SmartRAG" class="text-decoration-none me-3">
143+
<i class="fab fa-github"></i> GitHub
144+
</a>
145+
<a href="https://www.nuget.org/packages/SmartRAG" class="text-decoration-none me-3">
146+
<i class="fas fa-box"></i> NuGet
147+
</a>
148+
<a href="mailto:b.yerlikaya@outlook.com" class="text-decoration-none">
149+
<i class="fas fa-envelope"></i> Contact
150+
</a>
151+
</div>
152+
</div>
153+
</div>
154+
</footer>
155+
156+
<!-- Back to Top Button -->
157+
<button id="backToTop" class="btn btn-primary back-to-top">
158+
<i class="fas fa-arrow-up"></i>
159+
</button>
160+
161+
<!-- Bootstrap 5 JS -->
162+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
72163

73-
<!-- Just the Docs JS -->
74-
<script src="https://unpkg.com/just-the-docs@0.7.3/dist/just-the-docs.min.js"></script>
164+
<!-- Custom JS -->
165+
<script src="{{ site.baseurl }}/assets/js/main.js"></script>
75166
</body>
76167
</html>

0 commit comments

Comments
 (0)