Skip to content

Commit 7fe2668

Browse files
committed
The new website!
1 parent 299fce9 commit 7fe2668

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+7673
-835
lines changed

docs/.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
_site
2-
Gemfile
3-
Gemfile.lock
2+
.jekyll-metadata
3+
node_modules
4+
yarn-error.log
5+
Gemfile.lock

docs/Gemfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
source 'https://rubygems.org'
2+
3+
group :jekyll_plugins do
4+
gem 'github-pages'
5+
gem 'jekyll-sitemap'
6+
end

docs/_config.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11
plugins:
22
- jekyll-sitemap
3-
- jekyll-redirect-from
3+
- jekyll-redirect-from
4+
defaults:
5+
- scope:
6+
path: ""
7+
values:
8+
layout: "default"
9+
published_at: "2018-03-11"
10+
updated_at: "2018-03-11"

docs/_data/images.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/_data/menu.yml

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,37 @@
1-
Getting Started:
2-
Introduction: '/'
3-
Installation: '/installation/'
4-
Sponsors: '/sponsors/'
1+
Flysystem:
2+
Introduction: '/docs/'
3+
Sponsors: '/docs/sponsors/'
4+
Architecture: '/docs/architecture/'
55

66
Usage:
7-
Focus and Goals: '/focus-and-goals/'
8-
The API: '/api/'
9-
Integrations: '/integrations/'
7+
Setup / Bootstrap: '/docs/usage/setup/'
8+
Filesystem API: '/docs/usage/filesystem-api/'
109

10+
Guides:
11+
Deterministic Code: '/docs/guides/deterministic-programming/'
12+
Handling Uploads: '/docs/guides/uploads/'
1113

12-
Advanced Usage:
13-
Mount Manager: '/mount-manager/'
14-
Caching: '/caching/'
15-
Recipes: '/recipes/'
16-
Plugins: '/plugins/'
17-
Upgrade to 1.0.0: '/upgrade-to-1.0.0/'
18-
Creating an adapter: '/creating-an-adapter/'
19-
Performance: '/performance/'
2014
Adapters:
21-
Local: '/adapter/local/'
22-
Azure: '/adapter/azure/'
23-
AWS S3: '/adapter/aws-s3/'
24-
DigitalOcean Spaces: '/adapter/digitalocean-spaces/'
25-
Dropbox: '/adapter/dropbox/'
26-
FTP: '/adapter/ftp/'
27-
Memory: '/adapter/memory/'
28-
Null / Test: '/adapter/null-test/'
29-
Rackspace: '/adapter/rackspace/'
30-
ReplicateAdapter: '/adapter/replicate/'
31-
SFTP: '/adapter/sftp/'
32-
WebDAV: '/adapter/webdav/'
33-
PHPCR: '/adapter/phpcr/'
34-
ZipArchive: '/adapter/zip-archive/'
15+
Local: '/docs/adapter/local/'
16+
Azure: '/docs/adapter/azure/'
17+
AWS S3: '/docs/adapter/aws-s3/'
18+
DigitalOcean Spaces: '/docs/adapter/digitalocean-spaces/'
19+
Dropbox: '/docs/adapter/dropbox/'
20+
FTP: '/docs/adapter/ftp/'
21+
Memory: '/docs/adapter/memory/'
22+
Null / Test: '/docs/adapter/null-test/'
23+
Rackspace: '/docs/adapter/rackspace/'
24+
ReplicateAdapter: '/docs/adapter/replicate/'
25+
SFTP: '/docs/adapter/sftp/'
26+
WebDAV: '/docs/adapter/webdav/'
27+
PHPCR: '/docs/adapter/phpcr/'
28+
ZipArchive: '/docs/adapter/zip-archive/'
29+
30+
Advanced Usage:
31+
Performance: '/docs/advanced/performance/'
32+
Mount Manager: '/docs/advanced/mount-manager/'
33+
Caching: '/docs/advanced/caching/'
34+
Plugins: '/docs/advanced/plugins/'
35+
Provided Plugins: '/docs/advanced/provided-plugins/'
36+
Upgrade to 1.0.0: '/docs/advanced/upgrade-to-1.0.0/'
37+
Creating an adapter: '/docs/advanced/creating-an-adapter/'

docs/_data/project.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
title: "Flysystem"
2-
tagline: "Multiple Filesystems, One API"
3-
description: "Filesystem abstraction package allowing you to use the same API for both local, remote and cloud filesystems."
4-
google_analytics_tracking_id: "UA-114647967-1"
2+
tagline: "Many filesystems, one API."
3+
description: "Filesystem abstraction library for PHP."
4+
version: 1.0.44

docs/_includes/carbon.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=flysystemthephpleaguecom" id="_carbonads_js"></script>

docs/_includes/size-helper.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{% if site.data.dev.dev_mode %}
2+
<div class="fixed z-50 pin-t pin-l bg-black text-white rounded-br p-2 opacity-50">
3+
<span class="sm:hidden">&lt; sm</span>
4+
<span class="sm-md:block hidden">sm-md</span>
5+
<span class="md-lg:block hidden">md-lg</span>
6+
<span class="lg-xl:block hidden">lg-xl</span>
7+
<span class="xl:block hidden">&gt; xl</span>
8+
</div>
9+
{% endif %}

docs/_layouts/default.html

Lines changed: 81 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -3,100 +3,93 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
{% if page.url == '/' %}
8-
<title>{{ site.data.project.title }} - {{ site.data.project.tagline }}</title>
9-
{% else %}
10-
<title>{{ page.title }} - {{ site.data.project.title }}</title>
11-
{% endif %}
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0"/>
7+
<title>{{ page.title }} - {{ site.data.project.title }}</title>
8+
<link href="https://fonts.googleapis.com/css?family=Raleway|Varela+Round" rel="stylesheet"/>
129
{% if site.data.project.description %}
13-
<meta name="description" content="{{ site.data.project.description }}">
14-
{% endif %}
15-
{% if site.data.images.favicon %}
16-
<link rel="icon" type="image/x-icon" href="{{ site.data.images.favicon }}" />
17-
{% else %}
18-
<link rel="icon" type="image/x-icon" href="//theme.thephpleague.com/img/favicon.ico" />
10+
<meta name="description" content="{{ site.data.project.description }}">
1911
{% endif %}
20-
{% if site.data.images.apple_touch %}
21-
<link rel="apple-touch-icon-precomposed" href="{{ site.data.images.apple_touch }}">
22-
{% else %}
23-
<link rel="apple-touch-icon-precomposed" href="//theme.thephpleague.com/img/apple-touch-icon-precomposed.png">
12+
{% unless site.data.dev.dev_mode %}
13+
{% if site.data.project.google_analytics_tracking_id %}
14+
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.data.project.google_analytics_tracking_id }}"></script>
15+
<script>
16+
window.dataLayer = window.dataLayer || [];
17+
function gtag() { dataLayer.push(arguments);}
18+
gtag('js', new Date());
19+
gtag('config', '{{ site.data.project.google_analytics_tracking_id }}');
20+
</script>
2421
{% endif %}
25-
<link rel="stylesheet" href="//theme.thephpleague.com/css/all.css" />
26-
<link rel="stylesheet" href="/static/styles.css" />
27-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
28-
<!--<base href="//flysystem.thephpleague.com{{ page.permalink }}">-->
22+
{% endunless %}
23+
<!--<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />-->
24+
<link rel="stylesheet" href="/dist/styles.css"/>
2925
</head>
30-
<body>
31-
32-
<header>
33-
<a class="logo" href="/">
34-
{% if site.data.images.logo %}
35-
<span class="icon">
36-
<img src="{{ site.data.images.logo }}" width="50" height="40" alt="{{ site.data.project.title }} - {{ site.data.project.tagline }}">
37-
</span>
38-
{% endif %}
39-
<span class="name">{{ site.data.project.title }}</span>
40-
<span class="tagline">{{ site.data.project.tagline }}</span>
41-
</a>
42-
<!--<a href="//thephpleague.com/" class="league">-->
43-
<!--Presented by The League of Extraordinary Packages-->
44-
<!--</a>-->
45-
</header>
46-
47-
<input type="checkbox" id="menu">
48-
<label for="menu" onclick>
49-
<div class="closed">&#9776; Menu</div>
50-
<div class="open">&#9776; Hide Menu</div>
51-
</label>
52-
53-
<main>
54-
<menu>
55-
{% for section in site.data.menu %}
56-
<h2>{{ section[0] }}</h2>
57-
<ul>
58-
{% for link in section[1] %}
59-
<li {% if page.url == link[1] %}class="selected"{% endif %}>
60-
<a href="{{ link[1] }}">{{ link[0] }}</a>
26+
<body class="min-h-screen text-base text-indigo-body-text min-w-full pt-12 leading-normal bg-indigo-lightest">
27+
<!--{% include size-helper.html %}-->
28+
<div class="pb-1 fixed z-10 pin-t w-screen bg-white border-indigo-lighter border-b">
29+
<div class="max-w-2xl mx-auto px-4 py-2">
30+
<div class="flex items-center flex-no-shrink pt-1">
31+
<a href="/" class="flex items-center h-10">
32+
<img class="h-10 w-10 mr-3" width="30" height="30" src="/img/flysystem.svg"/>
33+
<span class="pr-2 font-normal overflow-hidden font-heading text-3xl text-indigo-darkest hidden sm:block">
34+
Flysystem
35+
<sup class="text-xs relative text-indigo" style="top: -20px;">{{ site.data.project.version }}</sup>
36+
</span>
37+
</a>
38+
<div class="flex-grow"></div>
39+
<!--<div class="flex-no-shrink flex-no-grow h-10 px-4 relative">-->
40+
<!--<input id="global-search" class="focus:outline-0 h-10 py-2 pl-8 pr-2 text-indigo-darker rounded bg-indigo-lightest focus:border-indigo-light focus:bg-white focus:placeholder-none max-w-xs w-full appearance-none" type="text" placeholder="Search the docs" />-->
41+
<!--<span class="pointer-events-none absolute pin-y pin-l pl-6 flex items-center">-->
42+
<!--<svg class="fill-current pointer-events-none text-indigo-light w-4 h-4 border-transparent border" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20"><path d="M12.9 14.32a8 8 0 1 1 1.41-1.41l5.35 5.33-1.42 1.42-5.33-5.34zM8 14A6 6 0 1 0 8 2a6 6 0 0 0 0 12z"/></svg>-->
43+
<!--</span>-->
44+
<!--</div>-->
45+
<a href="#" id="menu-toggle" class="block md:hidden h-8 w-8 border p-1 border-transparent text-grey hover:text-grey menu-closed">
46+
<svg class="menu-closed:shown fill-current h-full w-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20">
47+
<path d="M0 3h20v2H0V3zm0 6h20v2H0V9zm0 6h20v2H0v-2z"/>
48+
</svg>
49+
<svg class="menu-closed:hidden fill-current h-full w-full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20">
50+
<path d="M10 8.586L2.929 1.515 1.515 2.929 8.586 10l-7.071 7.071 1.414 1.414L10 11.414l7.071 7.071 1.414-1.414L11.414 10l7.071-7.071-1.414-1.414L10 8.586z"/>
51+
</svg>
52+
</a>
53+
</div>
54+
</div>
55+
</div>
56+
<main class="mx-auto max-w-2xl px-4 py-2">
57+
<div class="flex flex-grow">
58+
<nav role="navigation" id="navigation" class="md:w-4/14 w-full lg:relative hidden md:block font-heading pt-2">
59+
<menu class="pl-0 mt-0">
60+
{% for section in site.data.menu %}
61+
<h2 class="tracking-wide text-xs leading-loose tracking-wide text-indigo-light uppercase">{{ section[0] }}</h2>
62+
<ul class="list-reset mb-6 block pr-6">
63+
{% for link in section[1] %}
64+
<li class="block">
65+
<a class="leading-loose block w-full rounded text-md {% if page.url == link[1] %}text-white bg-indigo pl-2 -ml-2{% else %}text-indigo-darkest{% endif %}"
66+
href="{{ link[1] }}">{{ link[0] }}</a>
6167
</li>
68+
{% endfor %}
69+
</ul>
6270
{% endfor %}
63-
</ul>
64-
{% endfor %}
65-
</menu>
66-
<article>
67-
{{ content }}
68-
</article>
69-
</main>
70-
71-
<footer>
72-
<span>&copy; Copyright <a href="https://thephpleague.com">The League of Extraordinary Packages</a>.</span>
73-
<span>Flysystem is developed by <a href="https://frankdejonge.nl">Frank de Jonge</a>.</span>
74-
<span>Site design by <a href="https://reinink.ca">Jonathan Reinink</a>.</span>
75-
</footer>
76-
77-
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
78-
<script src="//theme.thephpleague.com/js/scripts.js"></script>
79-
<script src="//theme.thephpleague.com/js/prism.js"></script>
80-
81-
{% if site.data.project.google_analytics_tracking_id %}
82-
<script>
83-
(function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]=
84-
function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date;
85-
e=o.createElement(i);r=o.getElementsByTagName(i)[0];
86-
e.src='//www.google-analytics.com/analytics.js';
87-
r.parentNode.insertBefore(e,r)}(window,document,'script','ga'));
88-
ga('create','{{ site.data.project.google_analytics_tracking_id }}');ga('send','pageview');
89-
</script>
90-
{% endif %}
91-
92-
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
93-
<script type="text/javascript"> docsearch({
94-
apiKey: '439460ae4715ee79780b36ea5647db26',
95-
indexName: 'eventsauce',
96-
inputSelector: '#global-search',
97-
debug: {% if site.data.dev.dev_mode %}true{% else %}false{% endif %}
98-
});
99-
</script>
71+
</menu>
72+
</nav>
10073

74+
<article id="article" role="main" class="max-w-full md:block md:w-10/14">
75+
{% unless page.hide_title %}
76+
<h1 class="mb-4">{% if page.alternate_title %}{{ page.alternate_title }}{% else %}{{ page.title }}{% endif %}</h1>
77+
<!--<p class="text-xs text-indigo-dark rounded rounded-t-none mb-4 text-shadow inline-block">-->
78+
<!--{% if page.published_at != page.updated_at %}Last updated at {{ page.updated_at | date_to_long_string }} | {% endif %}Published at {{ page.published_at | date_to_long_string }}-->
79+
<!--</p>-->
80+
{% endunless %}
81+
{{ content }}
82+
</article>
83+
</div>
84+
</main>
85+
<script type="text/javascript" src="/dist/main.js"></script>
86+
<!--<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>-->
87+
<!--<script type="text/javascript"> docsearch({-->
88+
<!--apiKey: 'be7daf2d7afded0acb0589a0e304a423',-->
89+
<!--indexName: 'filesystem_thephpleague',-->
90+
<!--inputSelector: '#global-search',-->
91+
<!--debug: {% if site.data.dev.dev_mode %}true{% else %}false{% endif %}-->
92+
<!--});-->
93+
<!--</script>-->
10194
</body>
10295
</html>

docs/adapter/aws-s3-v2.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)