Skip to content

Commit 3bf1e27

Browse files
nyamsprodnyamsprod
committed
Improve documentation layout
1 parent c917611 commit 3bf1e27

8 files changed

Lines changed: 119 additions & 275 deletions

File tree

‎docs/_includes/footer.html‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<footer class="p-6 max-w-7xl mx-auto pb-32">
2+
<hr class="border-t border-light border-opacity-50 max-w-7xl mx-auto" />
3+
<div class="flex flex-col lg:flex-row gap-12 my-16 px-6 md:px-0">
4+
<a href="https://csv.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
5+
<img src="/assets/img/csv-logo.svg" alt="CSV Logo" class="" />
6+
<div class="flex flex-col">
7+
<div class="font-black text-lg text-dark">CSV</div>
8+
9+
<p class="text-light">Data manipulation made easy in PHP</p>
10+
</div>
11+
</a>
12+
13+
<a href="https://uri.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
14+
<img src="/assets/img/uri-logo.svg" alt="URI Logo" class="" />
15+
16+
<div class="flex flex-col">
17+
<div class="font-black text-lg text-dark">URI</div>
18+
<p class="text-light">Modern API to process URIs in PHP</p>
19+
</div>
20+
</a>
21+
22+
<a href="https://period.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
23+
<img src="/assets/img/period-logo.svg" alt="Period Logo" class="" />
24+
25+
<div class="flex flex-col">
26+
<div class="font-black text-lg text-dark">PERIOD</div>
27+
<p class="text-light">Time range API for PHP</p>
28+
</div>
29+
</a>
30+
</div>
31+
<hr class="border-t border-light border-opacity-50 max-w-7xl mx-auto mb-16" />
32+
<div class="gap-12 sm:gap-32 grid sm:grid-cols-1 md:grid-cols-3 lg:grid-cols-4">
33+
<div class="flex flex-col gap-3 sm:col-span-3 lg:col-span-1">
34+
<div class="text-csv-base font-black text-xl">Copyright</div>
35+
<a href="https://thephpleague.com" class="font-mono tracking-tighter text-sm underline transition-all hover-text">The League of <br />Extraordinary Packages</a>
36+
</div>
37+
38+
<div class="flex flex-col gap-3">
39+
<div class="text-dark font-black text-xl">Questions?</div>
40+
<p class="font-mono text-sm tracking-tighter">
41+
<a href="https://phpc.social/@nyamsprod" target="_blank" class="transition-all hover-text">
42+
Package created and maintained by <span class="underline">Ignace Nyamagana Butera.</span>
43+
</a>
44+
</p>
45+
</div>
46+
47+
<div class="flex flex-col gap-3">
48+
<div class="text-dark font-black text-xl">Design</div>
49+
<p class="font-mono text-sm tracking-tighter">
50+
<a href="https://twitter.com/sandr" target="_blank" class="transition-all hover-text">
51+
Brand and site design by <span class="underline">Sander van der Kolk</span>
52+
</a>
53+
</p>
54+
</div>
55+
56+
<div class="flex flex-col gap-3">
57+
<div class="font-black text-xl">License package</div>
58+
<p class="font-mono text-sm tracking-tighter">
59+
<a href="https://github.com/thephpleague/uri-src/blob/master/LICENSE" target="_blank" class="transition-all hover-text underline">
60+
The MIT License (MIT)
61+
</a>
62+
</p>
63+
</div>
64+
</div>
65+
</footer>

‎docs/_includes/meta.html‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
<meta name="viewport" content="width=device-width, initial-scale=1">
3+
<meta name="theme-color" content="#386FFF">
4+
<meta name="description" content="{{ description }}">
5+
<meta name="keywords" content="{{ site.data.project.keywords }}" />
6+
<meta name="docsearch:version" content="{{ version }}">
7+
8+
<link rel="icon" sizes="any" href="/assets/img/csv-logo.svg" type="image/svg+xml">
9+
<link rel="icon" sizes="32x32" href="/assets/img/favicon-32x32.png" type="image/png">
10+
<link rel="icon" sizes="16x16" href="/assets/img/favicon-16x16.png" type="image/png">
11+
<link rel="shortcut icon" href="/assets/img/favicon.ico">
12+
13+
<link rel="preconnect" href="https://fonts.googleapis.com">
14+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
15+
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@300;400;500&family=Onest:wght@300;400;500;600;700;900&display=swap" rel="stylesheet">
16+
<link href="{{ site.data.manifest['docs.css'] }}?v={{ site.time | date:'%s' }}" rel="stylesheet">
17+
<link href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" rel="stylesheet">
18+
19+
<meta name="twitter:card" content="summary_large_image" />
20+
<meta name="twitter:site" content="@thephpleague" />
21+
<meta name="twitter:title" content="{{ full_title }}" />
22+
<meta name="twitter:description" content="{{ description }}" />
23+
<meta name="twitter:creator" content="@nyamsprod" />
24+
<meta name="twitter:image:src" content="https://csv.thephpleague.com/assets/img/csv_large_logo.png" />
25+
26+
<meta itemprop="name" content="{{ full_title }}" />
27+
<meta itemprop="description" content="{{ description }}" />
28+
<meta itemprop="image" content="https://csv.thephpleague.com/assets/img/csv_large_logo.png" />
29+
30+
<meta property="og:title" content="{{ full_title }}" />
31+
<meta property="og:description" content="{{ description }}" />
32+
<meta property="og:image" content="https://csv.thephpleague.com/assets/img/csv_large_logo.png" />
33+
34+
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.data.project.google_analytics_tracking_id }}"></script>
35+
<script>
36+
window.dataLayer = window.dataLayer || [];
37+
function gtag() { dataLayer.push(arguments);}
38+
gtag('js', new Date());
39+
gtag('config', '{{ site.data.project.google_analytics_tracking_id }}');
40+
</script>

‎docs/_layouts/default.html‎

Lines changed: 5 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,16 @@
55
{% assign upgrading = true %}
66
{% endif %}
77
{% capture version_home %}/{{ version }}/{% endcapture %}
8+
{%- assign title = page.title | default: site.data.project.tagline -%}
9+
{%- assign description = page.description | default: site.data.project.description -%}
10+
{%- assign full_title = title | append: " - " | append: site.data.packages.package[package].description -%}
811
<!doctype html>
912
<html lang="en">
1013
<head>
1114
<meta charset="utf-8">
1215
<meta http-equiv="X-UA-Compatible" content="IE=edge">
13-
<meta name="viewport" content="width=device-width, initial-scale=1">
14-
<meta name="description" content="{{ site.data.project.description }}">
15-
<meta name="docsearch:version" content="{{ version }}">
1616
<title>{{ page.title }} - {{ site.data.project.title }}</title>
17-
<link rel="icon" href="/assets/img/csv-logo.svg" type="image/svg+xml">
18-
<link rel="apple-touch-icon-precomposed" href="//theme.thephpleague.com/img/apple-touch-icon-precomposed.png">
19-
<link rel="preconnect" href="https://fonts.googleapis.com">
20-
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
21-
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@300;400;500&family=Onest:wght@300;400;500;600;700;900&display=swap" rel="stylesheet">
22-
<link href="{{ site.data.manifest['docs.css'] }}?v={{ site.time | date:'%s' }}" rel="stylesheet">
23-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
24-
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.data.project.google_analytics_tracking_id }}"></script>
25-
<script>
26-
window.dataLayer = window.dataLayer || [];
27-
function gtag() { dataLayer.push(arguments);}
28-
gtag('js', new Date());
29-
gtag('config', '{{ site.data.project.google_analytics_tracking_id }}');
30-
</script>
17+
{%- include meta.html -%}
3118
</head>
3219
<body class="bg-white text-dark font-onest antialiased relative">
3320
<div class="relative z-10">
@@ -108,80 +95,7 @@ <h3 class="font-semibold tracking-tight text-slate-900">Older versions</h3>
10895
</article>
10996
</div>
11097
</main>
111-
<footer class="p-6 max-w-7xl mx-auto pb-32">
112-
<hr class="border-t border-light border-opacity-50 max-w-7xl mx-auto" />
113-
114-
<div class="flex flex-col lg:flex-row gap-12 my-16 px-6 md:px-0">
115-
<a href="https://csv.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
116-
<img src="/assets/img/csv-logo.svg" alt="CSV Logo" class="" />
117-
118-
<div class="flex flex-col">
119-
<div class="font-black text-lg text-dark">CSV</div>
120-
121-
<p class="text-light">Data manipulation made easy in PHP</p>
122-
</div>
123-
</a>
124-
125-
<a href="https://uri.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
126-
<img src="/assets/img/uri-logo.svg" alt="URI Logo" class="" />
127-
128-
<div class="flex flex-col">
129-
<div class="font-black text-lg text-dark">URI</div>
130-
131-
<p class="text-light">Modern API to process URIs in PHP</p>
132-
</div>
133-
</a>
134-
135-
<a href="https://period.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
136-
<img src="/assets/img/period-logo.svg" alt="Period Logo" class="" />
137-
138-
<div class="flex flex-col">
139-
<div class="font-black text-lg text-dark">PERIOD</div>
140-
141-
<p class="text-light">Time range API for PHP</p>
142-
</div>
143-
</a>
144-
</div>
145-
146-
<hr class="border-t border-light border-opacity-50 max-w-7xl mx-auto mb-16" />
147-
148-
<div class="gap-12 sm:gap-32 grid sm:grid-cols-1 md:grid-cols-3 lg:grid-cols-4">
149-
<div class="flex flex-col gap-3 sm:col-span-3 lg:col-span-1">
150-
<div class="text-csv-base font-black text-xl">Copyright</div>
151-
152-
<a href="//thephpleague.com" class="font-mono tracking-tighter text-sm underline transition-all hover-text">The League of <br />Extraordinary Packages</a>
153-
</div>
154-
155-
<div class="flex flex-col gap-3">
156-
<div class="text-dark font-black text-xl">Questions?</div>
157-
<p class="font-mono text-sm tracking-tighter">
158-
<a href="https://phpc.social/@nyamsprod" target="_blank" class="transition-all hover-text">
159-
Package created and maintained by <span class="underline">Ignace Nyamagana Butera.</span>
160-
</a>
161-
</p>
162-
</div>
163-
164-
<div class="flex flex-col gap-3">
165-
<div class="text-dark font-black text-xl">Design</div>
166-
167-
<p class="font-mono text-sm tracking-tighter">
168-
<a href="https://twitter.com/sandr" target="_blank" class="transition-all hover-text">
169-
Brand and site design by <span class="underline">Sander van der Kolk</span>
170-
</a>
171-
</p>
172-
</div>
173-
174-
<div class="flex flex-col gap-3">
175-
<div class="font-black text-xl">License package</div>
176-
177-
<p class="font-mono text-sm tracking-tighter">
178-
<a href="https://github.com/thephpleague/csv/blob/master/LICENSE" target="_blank" class="transition-all hover-text underline">
179-
The MIT License (MIT)
180-
</a>
181-
</p>
182-
</div>
183-
</div>
184-
</footer>
98+
{%- include footer.html -%}
18599
</div>
186100
<script src="{{ site.data.manifest['docs.js'] }}?v={{ site.time | date:'%s' }}"></script>
187101
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>

‎docs/_layouts/homepage.html‎

Lines changed: 5 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,10 @@
11
<!DOCTYPE html>
22
<html lang="en">
33
<head>
4-
<meta charset="UTF-8">
5-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<meta name="description" content="Working with CSV can often be much more difficult than you expect, with different types of delimiters and complicated structures. This library makes it easy to read and write almost anything.">
7-
<meta name="docsearch:version" content="4.0">
8-
<link rel="icon" href="/assets/img/csv-logo.svg" type="image/svg+xml">
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
96
<title>{{ site.data.project.tagline }} - {{ site.data.project.title }}</title>
10-
<link rel="preconnect" href="https://fonts.googleapis.com">
11-
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
12-
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@300;400;500&family=Onest:wght@300;400;500;600;700;900&display=swap" rel="stylesheet">
13-
<link href="{{ site.data.manifest['docs.css'] }}?v={{ site.time | date:'%s' }}" rel="stylesheet">
14-
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-46050814-6"></script>
15-
<script>
16-
window.dataLayer = window.dataLayer || [];
17-
18-
function gtag() {
19-
dataLayer.push(arguments);
20-
}
21-
gtag('js', new Date());
22-
gtag('config', '{{ site.data.project.google_analytics_tracking_id }}');
23-
</script>
7+
{%- include meta.html -%}
248
</head>
259
<body class="bg-white text-dark font-onest antialiased relative">
2610
<div class="relative z-10">
@@ -93,82 +77,8 @@ <h4 class="font-bold text-xl">Framework-agnostic</h4>
9377
</div>
9478
</div>
9579
</main>
96-
97-
<footer class="p-6 max-w-7xl mx-auto pb-32">
98-
<hr class="border-t border-light border-opacity-50 max-w-7xl mx-auto" />
99-
100-
<div class="flex flex-col lg:flex-row gap-12 my-16 px-6 md:px-0">
101-
<a href="https://csv.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
102-
<img src="/assets/img/csv-logo.svg" alt="CSV Logo" class="" />
103-
104-
<div class="flex flex-col">
105-
<div class="font-black text-lg text-dark">CSV</div>
106-
107-
<p class="text-light">Data manipulation made easy in PHP</p>
108-
</div>
109-
</a>
110-
111-
<a href="https://uri.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
112-
<img src="/assets/img/uri-logo.svg" alt="URI Logo" class="" />
113-
114-
<div class="flex flex-col">
115-
<div class="font-black text-lg text-dark">URI</div>
116-
117-
<p class="text-light">Modern API to process URIs in PHP</p>
118-
</div>
119-
</a>
120-
121-
<a href="https://period.thephpleague.com/" class="flex gap-3 lg:justify-between items-start transition-all hover-block">
122-
<img src="/assets/img/period-logo.svg" alt="Period Logo" class="" />
123-
124-
<div class="flex flex-col">
125-
<div class="font-black text-lg text-dark">PERIOD</div>
126-
127-
<p class="text-light">Time range API for PHP</p>
128-
</div>
129-
</a>
130-
</div>
131-
132-
<hr class="border-t border-light border-opacity-50 max-w-7xl mx-auto mb-16" />
133-
134-
<div class="gap-12 sm:gap-32 grid sm:grid-cols-1 md:grid-cols-3 lg:grid-cols-4">
135-
<div class="flex flex-col gap-3 sm:col-span-3 lg:col-span-1">
136-
<div class="text-csv-base font-black text-xl">Copyright</div>
137-
138-
<a href="//thephpleague.com" class="font-mono tracking-tighter text-sm underline transition-all hover-text">The League of <br />Extraordinary Packages</a>
139-
</div>
140-
141-
<div class="flex flex-col gap-3">
142-
<div class="text-dark font-black text-xl">Questions?</div>
143-
<p class="font-mono text-sm tracking-tighter">
144-
<a href="https://phpc.social/@nyamsprod" target="_blank" class="transition-all hover-text">
145-
Package created and maintained by <span class="underline">Ignace Nyamagana Butera.</span>
146-
</a>
147-
</p>
148-
</div>
149-
150-
<div class="flex flex-col gap-3">
151-
<div class="text-dark font-black text-xl">Design</div>
152-
153-
<p class="font-mono text-sm tracking-tighter">
154-
<a href="https://twitter.com/sandr" target="_blank" class="transition-all hover-text">
155-
Brand and site design by <span class="underline">Sander van der Kolk</span>
156-
</a>
157-
</p>
158-
</div>
159-
160-
<div class="flex flex-col gap-3">
161-
<div class="font-black text-xl">License package</div>
162-
163-
<p class="font-mono text-sm tracking-tighter">
164-
<a href="https://github.com/thephpleague/csv/blob/master/LICENSE" target="_blank" class="transition-all hover-text underline">
165-
The MIT License (MIT)
166-
</a>
167-
</p>
168-
</div>
169-
</div>
170-
</footer></div>
171-
80+
{%- include footer.html -%}
81+
</div>
17282
<div class="absolute z-0 flex justify-center top-0 right-0 left-0 overflow-hidden">
17383
<img src="/assets/img/csv-logo-big.svg" alt="Logo" class="w-1/2 sm:w-auto rotate-6 z-0 top-logo -right-logo"/>
17484
</div>

0 commit comments

Comments
 (0)