3 | {{ partial "nav.html" . }}
4 |
32 |
33 | {{ end }}
34 |
--------------------------------------------------------------------------------
/fetch-content.js:
--------------------------------------------------------------------------------
1 | const util = require("util");
2 | const exec = util.promisify(require("child_process").exec);
3 | console.log('Fetching repositories...');
4 | console.time('Fetched repositories');
5 |
6 | const repositories = require("./repositories.json");
7 |
8 | function transformBranchToFolderName(branch) {
9 | return branch.startsWith('v') ? branch.substring(1) : branch;
10 | }
11 |
12 | (async function () {
13 | let promises = [];
14 | await exec("rm -rf temp && rm -rf content/*");
15 |
16 | for (const repository of repositories) {
17 | for (const [branch, alias] of Object.entries(repository.branches)) {
18 | promises.push(exec(`mkdir -p content/${repository.name}/${alias} \
19 | && mkdir -p temp/${repository.name}/${alias} \
20 | && cd temp/${repository.name}/${alias} \
21 | && git init \
22 | && git config core.sparseCheckout true \
23 | && echo "/docs" >> .git/info/sparse-checkout \
24 | && git remote add -f origin https://${process.env.ACCESS_TOKEN}@github.com/spatie/${repository.name}.git \
25 | && git pull origin ${branch} \
26 | && cp -r docs/* ../../../content/${repository.name}/${alias} \
27 | && echo "---\ntitle: ${repository.name}\ncategory: ${repository.category}\n---" > ../../../content/${repository.name}/_index.md`));
28 | }
29 | }
30 |
31 | await Promise.all(promises)
32 | .catch(error => {
33 | console.log(error);
34 | })
35 | .finally(() => {
36 | exec("rm -rf temp");
37 | });
38 | console.timeEnd('Fetched repositories');
39 | })();
40 |
--------------------------------------------------------------------------------
/static/svg/spatie.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## THIS REPO IS NOT USED ANYMORE, DOCS NOW LIVE AT spatie/spatie.be
2 |
3 | # Spatie docs
4 |
5 | [](https://app.netlify.com/sites/docs-spatie/deploys)
6 |
7 | This repository contains the Hugo configuration of the docs site. The application is automatically deployed to https://docs.spatie.be
8 |
9 | ## Support us
10 |
11 | [
](https://spatie.be/github-ad-click/docs.spatie.be)
12 |
13 | We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
14 |
15 | We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
16 |
17 | ## Installation
18 |
19 | First ensure that Hugo is installed on your system.
20 |
21 | ```
22 | brew install hugo
23 | ```
24 |
25 | Node.js is also a requirement. You can download node.js from [nodejs.org](https://nodejs.org/en/).
26 |
27 | Next, fetch the content from our package repositories. You only need to run this step once.
28 |
29 | ```
30 | node fetch-content.js
31 | ```
32 |
33 | Now the site can be built with Hugo. During development, you can have Hugo spin up a local webserver and watch for changes.
34 |
35 | ```
36 | hugo server
37 | ```
38 |
39 | ## Contributing
40 |
41 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
42 |
43 | ### Security
44 |
45 | If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
46 |
47 | ## Credits
48 |
49 | - [Sebastian De Deyne](https://github.com/sebastiandedeyne)
50 | - [Rias Van der Veken](https://github.com/riasvdv)
51 | - [All Contributors](../../contributors)
52 |
53 | ## About Spatie
54 |
55 | Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
56 |
57 | ## License
58 |
59 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
60 |
--------------------------------------------------------------------------------
/netlify.toml:
--------------------------------------------------------------------------------
1 | [build]
2 | command = "node fetch-content.js && hugo -b https://docs.spatie.be"
3 | publish = "public"
4 |
5 | [context.production.environment]
6 | HUGO_VERSION = "0.55.5"
7 | HUGO_ENV = "production"
8 |
9 | [[redirects]]
10 | from = "https://docs-spatie.netlify.com/*"
11 | to = "https://docs.spatie.be/:splat"
12 | status = 301
13 | force = true
14 |
15 | [[redirects]]
16 | from = "/laravel-backup/"
17 | to = "/laravel-backup/v6/introduction"
18 | status = 301
19 | force = true
20 |
21 | [[redirects]]
22 | from = "/laravel-backup-server/"
23 | to = "/laravel-backup-server/v1/introduction"
24 | status = 301
25 | force = true
26 |
27 | [[redirects]]
28 | from = "/laravel-medialibrary/"
29 | to = "/laravel-medialibrary/v8/introduction"
30 | status = 301
31 | force = true
32 |
33 | [[redirects]]
34 | from = "/laravel-blade-x/"
35 | to = "/laravel-blade-x/v2/introduction"
36 | status = 301
37 | force = true
38 |
39 | [[redirects]]
40 | from = "/laravel-tags/"
41 | to = "/laravel-tags/v2/introduction"
42 | status = 301
43 | force = true
44 |
45 | [[redirects]]
46 | from = "/laravel-event-projector/"
47 | to = "/laravel-event-projector/v2/introduction"
48 | status = 301
49 | force = true
50 |
51 | [[redirects]]
52 | from = "/laravel-activitylog/"
53 | to = "/laravel-activitylog/v3/introduction"
54 | status = 301
55 | force = true
56 |
57 | [[redirects]]
58 | from = "/laravel-html/"
59 | to = "/laravel-html/v2/introduction"
60 | status = 301
61 | force = true
62 |
63 | [[redirects]]
64 | from = "/laravel-server-monitor/"
65 | to = "/laravel-server-monitor/v1/introduction"
66 | status = 301
67 | force = true
68 |
69 | [[redirects]]
70 | from = "/laravel-uptime-monitor/"
71 | to = "/laravel-uptime-monitor/v3/introduction"
72 | status = 301
73 | force = true
74 |
75 | [[redirects]]
76 | from = "/laravel-slack-slash-command/"
77 | to = "/laravel-slack-slash-command/v1/introduction"
78 | status = 301
79 | force = true
80 |
81 | [[redirects]]
82 | from = "/menu/"
83 | to = "/menu/v2/introduction"
84 | status = 301
85 | force = true
86 |
87 | [[redirects]]
88 | from = "/image/"
89 | to = "/image/v1/introduction"
90 | status = 301
91 | force = true
92 |
93 | [[redirects]]
94 | from = "/enum/"
95 | to = "/enum/v2/introduction"
96 | status = 301
97 | force = true
98 |
99 | [[redirects]]
100 | from = "/laravel-resource-links/"
101 | to = "/laravel-resource-links/v1/introduction"
102 | status = 301
103 | force = true
104 |
105 | [[redirects]]
106 | from = "/laravel-dashboard/"
107 | to = "/laravel-dashboard/v1/introduction"
108 | status = 301
109 | force = true
110 |
111 | [[redirects]]
112 | from = "/laravel-multitenancy/"
113 | to = "/laravel-multitenancy/v1/introduction"
114 | status = 301
115 | force = true
116 |
117 | [[redirects]]
118 | from = "/typescript-transformer/"
119 | to = "/typescript-transformer/v1/introduction"
120 | status = 301
121 | force = true
122 |
--------------------------------------------------------------------------------
/layouts/partials/nav.html:
--------------------------------------------------------------------------------
1 | {{ $package := .FirstSection.Title }}
2 | {{ $version := "" }}
3 | {{ range .FirstSection.Sections }}
4 | {{ if .IsAncestor $.Page }}
5 | {{ $version = .Title }}
6 | {{ end }}
7 | {{ end }}
8 |
9 | {{ range .Site.Sections.ByTitle }}
10 | {{ if eq .Title $package }}
11 | {{ range .Sections.ByWeight }}
12 | {{ if and (eq .Title $version) (gt (len .Pages) 1) }}
13 |
14 |
59 | {{ end }}
60 | {{ end }}
61 | {{ end }}
62 | {{ end }}
63 |
--------------------------------------------------------------------------------
/repositories.json:
--------------------------------------------------------------------------------
1 | [
2 | {
3 | "name": "laravel-backup",
4 | "repository": "spatie/laravel-backup",
5 | "branches": {
6 | "master": "v6",
7 | "v5": "v5",
8 | "v4": "v4",
9 | "v3": "v3"
10 | },
11 | "category": "Laravel"
12 | },
13 | {
14 | "name": "laravel-medialibrary",
15 | "repository": "spatie/laravel-medialibrary",
16 | "branches": {
17 | "master": "v8",
18 | "v7": "v7",
19 | "v6": "v6",
20 | "v5": "v5",
21 | "v4": "v4",
22 | "v3": "v3"
23 | },
24 | "category": "Laravel"
25 | },
26 | {
27 | "name": "laravel-blade-x",
28 | "repository": "spatie/laravel-blade-x",
29 | "branches": {
30 | "master": "v2"
31 | },
32 | "category": "Laravel"
33 | },
34 | {
35 | "name": "laravel-tags",
36 | "repository": "spatie/laravel-tags",
37 | "branches": {
38 | "master": "v2",
39 | "v1": "v1"
40 | },
41 | "category": "Laravel"
42 | },
43 | {
44 | "name": "laravel-activitylog",
45 | "repository": "spatie/laravel-activitylog",
46 | "branches": {
47 | "master": "v3",
48 | "v2": "v2",
49 | "v1": "v1"
50 | },
51 | "category": "Laravel"
52 | },
53 | {
54 | "name": "laravel-html",
55 | "repository": "spatie/laravel-html",
56 | "branches": {
57 | "master": "v2",
58 | "v1": "v1"
59 | },
60 | "category": "Laravel"
61 | },
62 | {
63 | "name": "laravel-server-monitor",
64 | "repository": "spatie/laravel-server-monitor",
65 | "branches": {
66 | "master": "v1"
67 | },
68 | "category": "Laravel"
69 | },
70 | {
71 | "name": "laravel-uptime-monitor",
72 | "repository": "spatie/laravel-uptime-monitor",
73 | "branches": {
74 | "master": "v3",
75 | "v2": "v2",
76 | "v1": "v1"
77 | },
78 | "category": "Laravel"
79 | },
80 | {
81 | "name": "laravel-slack-slash-command",
82 | "repository": "spatie/laravel-slack-slash-command",
83 | "branches": {
84 | "master": "v1"
85 | },
86 | "category": "Laravel"
87 | },
88 | {
89 | "name": "menu",
90 | "repository": "spatie/menu",
91 | "branches": {
92 | "master": "v2",
93 | "v1": "v1"
94 | },
95 | "category": "General PHP"
96 | },
97 | {
98 | "name": "image",
99 | "repository": "spatie/image",
100 | "branches": {
101 | "master": "v1"
102 | },
103 | "category": "General PHP"
104 | },
105 | {
106 | "name": "enum",
107 | "repository": "spatie/enum",
108 | "branches": {
109 | "master": "v3",
110 | "v2": "v2",
111 | "v1": "v1"
112 | },
113 | "category": "General PHP"
114 | },
115 | {
116 | "name": "laravel-model-states",
117 | "repository": "spatie/laravel-model-states",
118 | "branches": {
119 | "master": "v1"
120 | },
121 | "category": "Laravel"
122 | },
123 | {
124 | "name": "laravel-permission",
125 | "repository": "spatie/laravel-permission",
126 | "branches": {
127 | "master": "v3",
128 | "v2": "v2"
129 | },
130 | "category": "Laravel"
131 | },
132 | {
133 | "name": "laravel-query-builder",
134 | "repository": "spatie/laravel-query-builder",
135 | "branches": {
136 | "master": "v2"
137 | },
138 | "category": "Laravel"
139 | },
140 | {
141 | "name": "laravel-event-sourcing",
142 | "repository": "spatie/laravel-event-sourcing",
143 | "branches": {
144 | "master": "v4",
145 | "v3": "v3",
146 | "v2": "v2",
147 | "v1": "v1"
148 | },
149 | "category": "Laravel"
150 | },
151 | {
152 | "name": "laravel-resource-links",
153 | "repository": "spatie/laravel-resource-links",
154 | "branches": {
155 | "master": "v1"
156 | },
157 | "category": "Laravel"
158 | },
159 | {
160 | "name": "laravel-backup-server",
161 | "repository": "spatie/laravel-backup-server",
162 | "branches": {
163 | "master": "v1"
164 | },
165 | "category": "Laravel"
166 | },
167 | {
168 | "name": "laravel-dashboard",
169 | "repository": "spatie/laravel-dashboard",
170 | "branches": {
171 | "master": "v1"
172 | },
173 | "category": "Laravel"
174 | },
175 | {
176 | "name": "laravel-multitenancy",
177 | "repository": "spatie/laravel-multitenancy",
178 | "branches": {
179 | "master": "v1"
180 | },
181 | "category": "Laravel"
182 | },
183 | {
184 | "name": "typescript-transformer",
185 | "repository": "spatie/typescript-transformer",
186 | "branches": {
187 | "master": "v1"
188 | },
189 | "category": "General PHP"
190 | }
191 | ]
192 |
--------------------------------------------------------------------------------
/layouts/_default/baseof.html:
--------------------------------------------------------------------------------
1 | {{ $.Scratch.Set "package" .FirstSection.Title }}
2 | {{ range .FirstSection.Sections }}
3 | {{ if .IsAncestor $.Page }}
4 | {{ $.Scratch.Set "version" .Title }}
5 | {{ if (.Param "slogan") }}
6 | {{ $.Scratch.Set "slogan" (.Param "slogan") }}
7 | {{ end }}
8 | {{ if (.Param "githubUrl") }}
9 | {{ $.Scratch.Set "githubUrl" (.Param "githubUrl") }}
10 | {{ end }}
11 | {{ if (.Param "branch") }}
12 | {{ $.Scratch.Set "branch" (.Param "branch") }}
13 | {{ else }}
14 | {{ $.Scratch.Set "branch" "master" }}
15 | {{ end }}
16 | {{ end }}
17 | {{ end }}
18 | {{ $latest := "" }}
19 | {{ range sort .FirstSection.Sections.ByWeight.Reverse }}
20 | {{ if not ($.Scratch.Get "latest") }}
21 | {{ $.Scratch.Set "latest" .Title }}
22 | {{ end }}
23 | {{ end }}
24 | {{ if not (eq ($.Scratch.Get "latest") ($.Scratch.Get "version")) }}
25 | {{ range .FirstSection.Sections }}
26 | {{ if eq ($.Scratch.Get "latest") .Title }}
27 | {{ $page := index (.Pages) 0 }}
28 | {{ $.Scratch.Set "latestUrl" $page.Permalink }}
29 | {{ end }}
30 | {{ end }}
31 | {{ end }}
32 | {{ if not ($.Scratch.Get "slogan") }}
33 | {{ $.Scratch.Set "slogan" "Documentation for our comprehensive packages" }}
34 | {{ end }}
35 | {{ if not ($.Scratch.Get "githubUrl") }}
36 | {{ $.Scratch.Set "githubUrl" "https://github.com/spatie/docs.spatie.be" }}
37 | {{ end }}
38 |
39 |
40 |
41 | {{ if ne .Title ($.Scratch.Get "package") }}
42 |
15 |
16 | {{ if eq $package "laravel-medialibrary" }}
17 |
21 | 
34 | {{ end }}
35 |
56 |
57 |
58 |
22 | We are working on MediaLibrary UI components.
23 |
Coming Fall 2020
24 |
26 | medialibrary.pro 30 |
31 | 32 | {{ else }} 33 |
34 | {{ end }}
35 |
56 |
65 |
109 |
66 |
108 |
67 |
87 |
99 |
107 | 68 | {{ $.Scratch.Get "package" }} 69 | {{ if and (gt (len .FirstSection.Sections) 1) (not .IsHome) }} 70 | 71 | {{ $.Scratch.Get "version" }} 72 | 73 | 74 | {{ end }} 75 |
76 | {{ if and (gt (len .FirstSection.Sections) 1) (not .IsHome) }} 77 | 85 | {{ end }} 86 |87 |
88 | {{ $.Scratch.Get "slogan" }} 89 | {{ if and ($.Scratch.Get "version") (not (eq ($.Scratch.Get "latest") ($.Scratch.Get "version"))) }} 90 | {{ range .FirstSection.Sections }} 91 | {{ if eq ($.Scratch.Get "latest") .Title }} 92 | {{ $page := index (.Pages) 0 }} 93 | — A newer version is available! 94 | {{ end }} 95 | {{ end }} 96 | {{ end }} 97 |
98 |":S.tabReplace?t.replace(/\t/g,S.tabReplace):""}):e}function f(e,t,n){var a=t?T[t]:n,o=[e.trim()];return e.match(/\bhljs\b/)||o.push("hljs"),-1===e.indexOf(a)&&o.push(a),o.join(" ").trim()}function m(e){var t=i(e),n,a,s,d,c;o(t)||(S.useBR?(n=document.createElementNS("http://www.w3.org/1999/xhtml","div"),n.innerHTML=e.innerHTML.replace(/\n/g,"").replace(/