浏览代码

feat: Refactor pagination and table of contents into separate includes for better maintainability

codecalm 3 月之前
父节点
当前提交
c8fee60023
共有 4 个文件被更改,包括 69 次插入59 次删除
  1. 二进制
      docs/public/img/banner-carbon.png
  2. 46 0
      shared/includes/docs/pagination.html
  3. 21 0
      shared/includes/docs/toc.html
  4. 2 59
      shared/layouts/docs/default.html

二进制
docs/public/img/banner-carbon.png


+ 46 - 0
shared/includes/docs/pagination.html

@@ -0,0 +1,46 @@
+{% assign children = collections.docs | collection-children: page %}
+{% if children.size > 0 %}
+<div class="mt-6 pt-6">
+	<div class="row row-deck row-cards">
+		{% for c in children %}
+		{% include "docs/docs-card.html" href=c.url title=c.data.title description=c.data.description icon=c.data.icon %}
+		{% endfor %}
+	</div>
+</div>
+{% else %}
+{% assign next-prev = collections.docs | next-prev: page %}
+<div class="mt-6 pt-6">
+	<ul class="pagination">
+		{% if next-prev.prev %}
+		<li class="page-item page-prev">
+			<a class="page-link" href="{{ next-prev.prev.url }}">
+				<div class="row align-items-center">
+					<div class="col-auto">
+						{% include "ui/icon.html" icon="chevron-left" %}
+					</div>
+					<div class="col">
+						<div class="page-item-subtitle">previous</div>
+						<div class="page-item-title">{{ next-prev.prev.data.title }}</div>
+					</div>
+				</div>
+			</a>
+		</li>
+		{% endif %}
+		{% if next-prev.next %}
+		<li class="page-item page-next">
+			<a class="page-link" href="{{ next-prev.next.url }}">
+				<div class="row align-items-center">
+					<div class="col">
+						<div class="page-item-subtitle">next</div>
+						<div class="page-item-title">{{ next-prev.next.data.title }}</div>
+					</div>
+					<div class="col-auto">
+						{% include "ui/icon.html" icon="chevron-right" %}
+					</div>
+				</div>
+			</a>
+		</li>
+		{% endif %}
+	</ul>
+</div>
+{% endif %}

+ 21 - 0
shared/includes/docs/toc.html

@@ -0,0 +1,21 @@
+{% assign toc = content | toc %}
+{% if toc.size > 0 %}
+<h3>
+	Table of Contents
+</h3>
+<div class="nav nav-vertical" id="toc">
+	{% for item in toc %}
+	<a href="#{{ item.id }}" class="nav-link{% if item.level == 3 %} ms-3{% endif %}">
+		{{ item.text }}
+	</a>
+	{% endfor %}
+</div>
+{% endif %}
+
+<a href="https://r.tabler.io/illustrations" class="card card-sm mt-6 shadow-none" target="_blank">
+	<div class="card-body">
+		<img src="/img/banner-carbon.png" class="mb-3" alt="">
+
+		<h4>{{ illustrations | size }} sleek illustrations for your startup's visual identity.</h4>
+	</div>
+</a>

+ 2 - 59
shared/layouts/docs/default.html

@@ -107,52 +107,7 @@
 
 								{{ content | headings-id }}
 
-								{% assign children = collections.docs | collection-children: page %}
-								{% if children.size > 0 %}
-									<div class="mt-6 pt-6">
-										<div class="row row-deck row-cards">
-											{% for c in children %}
-											{% include "docs/docs-card.html" href=c.url title=c.data.title description=c.data.description icon=c.data.icon %}
-											{% endfor %}
-										</div>
-									</div>
-								{% else %}
-									{% assign next-prev = collections.docs | next-prev: page %}
-									<div class="mt-6 pt-6">
-										<ul class="pagination">
-											{% if next-prev.prev %}
-											<li class="page-item page-prev">
-												<a class="page-link" href="{{ next-prev.prev.url }}">
-													<div class="row align-items-center">
-														<div class="col-auto">
-															{% include "ui/icon.html" icon="chevron-left" %}
-														</div>
-														<div class="col">
-															<div class="page-item-subtitle">previous</div>
-															<div class="page-item-title">{{ next-prev.prev.data.title }}</div>
-														</div>
-													</div>
-												</a>
-											</li>
-											{% endif %}
-											{% if next-prev.next %}
-											<li class="page-item page-next">
-												<a class="page-link" href="{{ next-prev.next.url }}">
-													<div class="row align-items-center">
-														<div class="col">
-															<div class="page-item-subtitle">next</div>
-															<div class="page-item-title">{{ next-prev.next.data.title }}</div>
-														</div>
-														<div class="col-auto">
-															{% include "ui/icon.html" icon="chevron-right" %}
-														</div>
-													</div>
-												</a>
-											</li>
-											{% endif %}
-										</ul>
-									</div>
-								{% endif %}
+								{% include "docs/pagination.html" %}
 
 								<div class="mt-7">
 									<div>
@@ -187,19 +142,7 @@
 				</div>
 				<div class="col-2 d-none d-xxl-block">
 					<div class="py-6 sticky-top">
-						{% assign toc = content | toc %}
-						{% if toc.size > 0 %}
-							<h3>
-								Table of Contents
-							</h3>
-							<div class="nav nav-vertical" id="toc">
-								{% for item in toc %}
-								<a href="#{{ item.id }}" class="nav-link{% if item.level == 3 %} ms-3{% endif %}">
-									{{ item.text }}
-								</a>
-								{% endfor %}
-							</div>
-						{% endif %}
+						{% include "docs/toc.html" %} 
 					</div>
 				</div>
 			</div>