Skip to content

Commit 308f813

Browse files
MahmoudzMahmoudz
committed
Enhance the design and readability of the docs
1 parent 9acb18a commit 308f813

4 files changed

Lines changed: 73 additions & 104 deletions

File tree

‎DOCUMENTATION/content/introduction/index.md‎

Lines changed: 27 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,34 @@ type: index
44
weight: 1
55
---
66

7-
![](https://raw.githubusercontent.com/laradock/laradock/master/.github/home-page-images/laradock-logo.jpg)
7+
<b>Laradock is a full PHP development environment based on Docker.</b>
88

9-
## Use Docker First - Then Learn About It Later
10-
11-
Laradock is a PHP development environment that runs on Docker.
12-
13-
Supports a variety of useful Docker Images, pre-configured to provide a wonderful PHP development environment.
9+
Supporting a variety of common services, all pre-configured to provide a full PHP development environment.
1410

1511

12+
<a name="features"></a>
13+
## Features
1614

15+
- Easy switch between PHP versions: 7.3, 7.2, 7.1, 5.6...
16+
- Choose your favorite database engine: MySQL, Postgres, MariaDB...
17+
- Run your own stack: Memcached, HHVM, RabbitMQ...
18+
- Each software runs on its own container: PHP-FPM, NGINX, PHP-CLI...
19+
- Easy to customize any container, with simple edit to the `Dockerfile`.
20+
- All Images extends from an official base Image. (Trusted base Images).
21+
- Pre-configured NGINX to host any code at your root directory.
22+
- Can use Laradock per project, or single Laradock for all projects.
23+
- Easy to install/remove software's in Containers using environment variables.
24+
- Clean and well structured Dockerfiles (`Dockerfile`).
25+
- Latest version of the Docker Compose file (`docker-compose`).
26+
- Everything is visible and editable.
27+
- Fast Images Builds.
1728

29+
<br>
1830

1931
---
32+
### Use Docker First - Then Learn About It Later</q>
33+
---
34+
2035

2136
<a name="sponsors"></a>
2237
## Sponsors
@@ -79,7 +94,8 @@ Your logo will show up on the [github repository](https://github.com/laradock/la
7994
<br>
8095
For more info contact <a href = "mailto: support@laradock.io">support@laradock.io</a>.
8196

82-
---
97+
<br>
98+
8399

84100
## Quick Overview
85101

@@ -120,25 +136,6 @@ That's it! enjoy :)
120136
121137
122138
123-
<a name="features"></a>
124-
## Features
125-
126-
- Easy switch between PHP versions: 7.3, 7.2, 7.1, 5.6...
127-
- Choose your favorite database engine: MySQL, Postgres, MariaDB...
128-
- Run your own stack: Memcached, HHVM, RabbitMQ...
129-
- Each software runs on its own container: PHP-FPM, NGINX, PHP-CLI...
130-
- Easy to customize any container, with simple edit to the `Dockerfile`.
131-
- All Images extends from an official base Image. (Trusted base Images).
132-
- Pre-configured NGINX to host any code at your root directory.
133-
- Can use Laradock per project, or single Laradock for all projects.
134-
- Easy to install/remove software's in Containers using environment variables.
135-
- Clean and well structured Dockerfiles (`Dockerfile`).
136-
- Latest version of the Docker Compose file (`docker-compose`).
137-
- Everything is visible and editable.
138-
- Fast Images Builds.
139-
140-
141-
142139
<a name="Supported-Containers"></a>
143140
## Supported Software (Docker Images)
144141
@@ -273,48 +270,6 @@ You can choose, which tools to install in your workspace container and other con
273270

274271
---
275272

276-
<a name="what-is-docker"></a>
277-
## What is Docker?
278-
279-
[Docker](https://www.docker.com) is an open platform for developing, shipping, and running applications.
280-
Docker enables you to separate your applications from your infrastructure so you can deliver software quickly.
281-
With Docker, you can manage your infrastructure in the same ways you manage your applications.
282-
By taking advantage of Docker’s methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.
283-
284-
285-
286-
287-
288-
<a name="why-docker-not-vagrant"></a>
289-
## Why Docker not Vagrant!?
290-
291-
[Vagrant](https://www.vagrantup.com) creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.
292-
293-
Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you **lightweight** Virtual Containers, that share the same kernel and allow to safely execute independent processes.
294-
295-
In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.
296-
297-
Most importantly Docker can run on Development and on Production (same environment everywhere). While Vagrant is designed for Development only, (so you have to re-provision your server on Production every time).
298-
299-
300-
301-
302-
303-
304-
<a name="Demo"></a>
305-
## Demo Video
306-
307-
What's better than a **Demo Video**:
308-
309-
- Laradock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
310-
- Laradock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
311-
- Laradock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
312-
- Laradock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
313-
314-
315-
316-
317-
318273

319274

320275
<a name="Chat"></a>
@@ -324,10 +279,11 @@ You are welcome to join our chat room on Gitter.
324279

325280
[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
326281

327-
## Awesome People
282+
---
283+
328284
Laradock exists thanks to all the people who contribute.
329285

330-
### Project Maintainers
286+
## Project Maintainers
331287

332288
<table>
333289
<tbody>
@@ -445,7 +401,7 @@ Laradock exists thanks to all the people who contribute.
445401
</tbody>
446402
</table>
447403

448-
### Code Contributors
404+
## Code Contributors
449405

450406
<a href="https://github.com/undefined/undefined/graphs/contributors"><img src="https://opencollective.com/laradock/contributors.svg?width=890&button=false" /></a>
451407

‎DOCUMENTATION/static/custom-style.css‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,20 @@
1111
height: 70px;
1212
padding: 25px;
1313
}
14+
.palette-primary-deep-purple .article h1{
15+
color: #7e57c2;
16+
font-size: 35px;
17+
}
18+
.palette-primary-deep-purple .article h2{
19+
20+
color: #ce2046;
21+
font-size: 25px;
22+
}
23+
.palette-primary-deep-purple .article h3{
24+
color: #851d54;
25+
font-size: 18px;
26+
}
27+
.palette-primary-deep-purple .article code{
28+
color: #851d54;
29+
background: #eeeeeea8;
30+
}

‎DOCUMENTATION/themes/hugo-material-docs/layouts/index.html‎

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{{ partial "head" . }}
22

33
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
4-
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
5-
{{ .Scratch.Set "repo_id" $repo_id }}
4+
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
5+
{{ .Scratch.Set "repo_id" $repo_id }}
66
{{ end }}
77

88
<div class="backdrop">
@@ -25,26 +25,32 @@
2525
<article class="article">
2626
<div class="wrapper">
2727

28-
<!-- Wrapper arround google ads for seedanddew -->
29-
<div class='snd-ad'>
30-
<!-- ------------------------------------------------------------------------- -->
31-
<!-- Google Ads -->
32-
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
33-
<!-- Laradock Horizontal -->
34-
<ins class="adsbygoogle"
35-
style="display:inline-block;width:890px;height:100px"
36-
data-ad-client="ca-pub-9826129398689742"
37-
data-ad-slot="2340256024"></ins>
38-
<script>
39-
(adsbygoogle = window.adsbygoogle || []).push({});
40-
</script>
41-
<!-- ------------------------------------------------------------------------- -->
42-
</div>
28+
<!-- Wrapper arround google ads for seedanddew -->
29+
<div class='snd-ad'>
30+
<!-- ------------------------------------------------------------------------- -->
31+
<!-- Google Ads -->
32+
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
33+
<!-- Laradock Horizontal -->
34+
<ins class="adsbygoogle"
35+
style="display:inline-block;width:890px;height:100px"
36+
data-ad-client="ca-pub-9826129398689742"
37+
data-ad-slot="2340256024"></ins>
38+
<script>
39+
(adsbygoogle = window.adsbygoogle || []).push({});
40+
</script>
41+
<!-- ------------------------------------------------------------------------- -->
42+
</div>
43+
44+
<br><br><br>
45+
<img src="https://raw.githubusercontent.com/laradock/laradock/master/.github/home-page-images/laradock-logo.jpg" alt="laradock logo">
4346

4447
{{ range where .Site.Pages "Type" "index" }}
45-
<h1>{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}</h1>
48+
<br><br><br><br><br><br>
49+
<hr>
50+
<br>
51+
<h1>{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}</h1>
4652

47-
{{ .Content }}
53+
{{ .Content }}
4854
{{ end }}
4955

5056
<aside class="copyright" role="note">
@@ -55,8 +61,8 @@ <h1>{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}</h1>
5561
<a href="https://www.gohugo.io" target="_blank">Hugo</a>
5662
using the
5763
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme,
58-
by
59-
<a href="https://zalt.me">Mahmoud Zalt</a>.
64+
by
65+
<a href="https://zalt.me">Mahmoud Zalt</a>.
6066
</aside>
6167

6268
<footer class="footer">

‎README.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44

55
---
66

7-
<p align="center">PHP development environment that runs on Docker</p>
7+
<p align="center"><b>Full PHP development environment based on Docker.</b></p>
88

9+
<p align="center">Supporting a variety of common services, all pre-configured to provide a full PHP development environment.</p>
910

1011
<p align="center">
1112
<a href="http://laradock.io/contributing"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="contributions welcome"></a>
@@ -173,19 +174,8 @@ Contribute and help us sustain the project.
173174

174175
<a href="https://opencollective.com/laradock"><img src="https://opencollective.com/laradock/backer.svg?width=890"></a>
175176

176-
177-
178-
179-
180-
181-
182177
## Sponsors
183178

184-
185-
186-
187-
188-
189179
<a href="https://opencollective.com/socketio/sponsor/23/website" target="_blank"><img src="https://opencollective.com/socketio/sponsor/23/avatar.svg"></a>
190180
<a href="https://opencollective.com/laradock/sponsor/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/laradock/sponsor/0/avatar.svg?requireActive=false"></a>
191181
<a href="https://opencollective.com/laradock/sponsor/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/laradock/sponsor/1/avatar.svg?requireActive=false"></a>

0 commit comments

Comments
 (0)