Skip to content

Commit b2821b8

Browse files
Merge pull request laradock#881 from winfried-van-loon/revert-unintended-md-formatting
Reverting unintended MD formatting
2 parents 47150da + 9413f2c commit b2821b8

2 files changed

Lines changed: 206 additions & 222 deletions

File tree

DOCUMENTATION/content/getting-started/index.md

Lines changed: 42 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,45 @@ type: index
44
weight: 2
55
---
66

7-
# Requirements
7+
## Requirements
88

99
- [Git](https://git-scm.com/downloads)
1010
- [Docker](https://www.docker.com/products/docker/) `>= 1.12`
1111

12-
# Installation
1312

14-
Choose the setup the best suits your needs.
1513

16-
- [A) Setup for Single Project](#A)
1714

18-
- [A.1) Already have a PHP project](#A1)
1915

20-
- [A.2) Don't have a PHP project yet](#A2)
2116

22-
- [B) Setup for Multiple Projects](#B)
2317

24-
[]()
18+
## Installation
2519

26-
## A) Setup for Single Project
20+
Choose the setup the best suits your needs.
2721

22+
- [A) Setup for Single Project](#A)
23+
- [A.1) Already have a PHP project](#A1)
24+
- [A.2) Don't have a PHP project yet](#A2)
25+
- [B) Setup for Multiple Projects](#B)
26+
27+
28+
<a name="A"></a>
29+
### A) Setup for Single Project
2830
> (Follow these steps if you want a separate Docker environment for each project)
2931
30-
[]()
3132

32-
## A.1) Already have a PHP project:
33+
<a name="A1"></a>
34+
### A.1) Already have a PHP project:
3335

3436
1 - Clone laradock on your project root directory:
3537

3638
```bash
3739
git submodule add https://github.com/Laradock/laradock.git
3840
```
3941

40-
Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule`.
42+
Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule `.
43+
44+
*To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#keep-track-of-your-laradock-changes)*
4145

42-
_To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#keep-track-of-your-laradock-changes)_
4346

4447
Your folder structure should look like this:
4548

@@ -50,13 +53,12 @@ Your folder structure should look like this:
5053
+ laradock-b
5154
```
5255

53-
_(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project)._
56+
*(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).*
5457

5558
> **Now jump to the [Usage](#Usage) section.**
5659
57-
[]()
58-
59-
## A.2) Don't have a PHP project yet:
60+
<a name="A2"></a>
61+
### A.2) Don't have a PHP project yet:
6062

6163
1 - Clone this repository anywhere on your machine:
6264

@@ -89,13 +91,12 @@ Make sure to replace `project-z` with your project folder name.
8991

9092
> **Now jump to the [Usage](#Usage) section.**
9193
92-
[]()
93-
94-
## B) Setup for Multiple Projects:
9594

95+
<a name="B"></a>
96+
### B) Setup for Multiple Projects:
9697
> (Follow these steps if you want a single Docker environment for all your project)
9798
98-
1 - Clone this repository anywhere on your machine (similar to [Steps A.2\. from above](#A2)):
99+
1 - Clone this repository anywhere on your machine (similar to [Steps A.2. from above](#A2)):
99100

100101
```bash
101102
git clone https://github.com/laradock/laradock.git
@@ -126,20 +127,25 @@ You can rename the config files, project folders and domains as you like, just m
126127

127128
> **Now jump to the [Usage](#Usage) section.**
128129
129-
[]()
130130

131-
# Usage
131+
132+
133+
134+
135+
136+
<a name="Usage"></a>
137+
## Usage
132138

133139
**Read Before starting:**
134140

135141
If you are using **Docker Toolbox** (VM), do one of the following:
136142

137143
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading Laradock](/documentation/#upgrading-laradock)
138-
- Use Laradock v3.*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/Laradock-ToolBox) branch. _(outdated)_
144+
- Use Laradock v3.\*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/Laradock-ToolBox) branch. *(outdated)*
139145

140146
<br>
141147

142-
> **Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent as much errors as possible.
148+
>**Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent as much errors as possible.
143149
144150
<br>
145151

@@ -151,6 +157,7 @@ cp env-example .env
151157

152158
You can edit the `.env` file to chose which software's you want to be installed in your environment. You can always refer to the `docker-compose.yml` file to see how those variables are been used.
153159

160+
154161
2 - Build the enviroment and run it using `docker-compose`
155162

156163
In this example we'll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:
@@ -161,9 +168,11 @@ docker-compose up -d nginx mysql
161168

162169
**Note**: The `workspace` and `php-fpm` will run automatically in most of the cases, so no need to specify them in the `up` command. If you couldn't find them running then you need specify them as follow: `docker-compose up -d nginx php-fpm mysql workspace`.
163170

171+
164172
You can select your own combination of containers form [this list](http://laradock.io/introduction/#supported-software-images).
165173

166-
_(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers)._
174+
*(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers).*
175+
167176

168177
<br>
169178
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...)
@@ -172,19 +181,19 @@ _(Please note that sometimes we forget to update the docs, so check the `docker-
172181
docker-compose exec workspace bash
173182
```
174183

175-
_Alternatively, for Windows PowerShell users: execute the following command to enter any running container:_
184+
*Alternatively, for Windows PowerShell users: execute the following command to enter any running container:*
176185

177186
```bash
178187
docker exec -it {workspace-container-id} bash
179188
```
180189

181-
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
190+
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
182191

183192
```shell
184193
docker-compose exec --user=laradock workspace bash
185194
```
186195

187-
_You can change the PUID (User id) and PGID (group id) variables from the `.env` file)_
196+
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
188197

189198
<br>
190199
4 - Update your project configurations to use the database host
@@ -195,7 +204,9 @@ Open your PHP project's `.env` file or whichever configuration file you are read
195204
DB_HOST=mysql
196205
```
197206

198-
_If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel)._
207+
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
199208

200209
<br>
201-
5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.dev/` and `http://project-2.dev/`. But first don't
210+
5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.dev/` and `http://project-2.dev/`. But first don't
211+
212+

0 commit comments

Comments
 (0)