Skip to content
This repository was archived by the owner on Jan 25, 2022. It is now read-only.

Commit bba4767

Browse files
author
Daryl Lozupone
committed
Update README formatting
1 parent d83ecf2 commit bba4767

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

README.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
1-
#WPLib Box
1+
# WPLib Box
22

33
**The EASIEST way to get a local WordPress development environment**, using Vagrant.
44

55
----
66

7-
## [CLICK HERE](https://slackpass.io/wplib) for **quick help** via [`wplib.slack.com#box`](FAQ.md#slack).
8-
## [CLICK HERE](FAQ.md#troubleshooting) for **troubleshooting** and other [FAQs](FAQ.md).
7+
## [CLICK HERE](https://slackpass.io/wplib) for **quick help** via [`wplib.slack.com# box`](FAQ.md# slack).
8+
## [CLICK HERE](FAQ.md# troubleshooting) for **troubleshooting** and other [FAQs](FAQ.md).
99

1010
----
1111

12-
- [Why Use WPLib Box?](#why-wplib-box)
13-
- [Services & Software Included](#whats-included)
14-
- [Required Hardware](#required-hw)
15-
- [Required Software](#required-sw)
16-
- [Quickstart](#quickstart)
17-
- [Setting the Domain Name](#setting-domain)
18-
- [Changing the Local IP Address](#change-ip)
19-
- [Default PHP Version for the Web](#web-php)
20-
- [Switching PHP Versions](#switching-php)
21-
- [Logging into the WordPress Admin](#wp-admin)
22-
- [The WordPress Database Credentials](#wpdb)
23-
- [The MySQL Credentials](#mysql-credentials)
24-
- [Connecting to MySQL in Terminal](#mysql-terminal)
25-
- [The SSH Credentials](#ssh-credentials)
26-
- [Logging into SSH as root](#ssh-root)
27-
- [Debugging PHP with XDEBUG and PhpStorm](#xdebug)
28-
- [Internet Sharing](#internet-sharing)
29-
- [Troubleshooting](#troubleshooting)
30-
- [How are we the Best?](#how-best)
12+
- [Why Use WPLib Box?](# why-wplib-box)
13+
- [Services & Software Included](# whats-included)
14+
- [Required Hardware](# required-hw)
15+
- [Required Software](# required-sw)
16+
- [Quickstart](# quickstart)
17+
- [Setting the Domain Name](# setting-domain)
18+
- [Changing the Local IP Address](# change-ip)
19+
- [Default PHP Version for the Web](# web-php)
20+
- [Switching PHP Versions](# switching-php)
21+
- [Logging into the WordPress Admin](# wp-admin)
22+
- [The WordPress Database Credentials](# wpdb)
23+
- [The MySQL Credentials](# mysql-credentials)
24+
- [Connecting to MySQL in Terminal](# mysql-terminal)
25+
- [The SSH Credentials](# ssh-credentials)
26+
- [Logging into SSH as root](# ssh-root)
27+
- [Debugging PHP with XDEBUG and PhpStorm](# xdebug)
28+
- [Internet Sharing](# internet-sharing)
29+
- [Troubleshooting](# troubleshooting)
30+
- [How are we the Best?](# how-best)
3131
- [3rd Party WPLib Box Projects](#3rd-party)
32-
- [Status of Issues](#issues-status)
33-
- [Future Plans](#future-plans)
32+
- [Status of Issues](# issues-status)
33+
- [Future Plans](# future-plans)
3434

3535
---
3636

3737
<a id="why-wplib-box"></a>
38-
##Why Use WPLib Box?
38+
## Why Use WPLib Box?
3939

4040
Why Use WPLib Box for WordPress local development instead of one of the other Vagrant boxes for WordPress such as [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV), [VIP QuickStart](https://github.com/Automattic/vip-quickstart), [Trellis](https://github.com/roots/trellis) or [one of the others](http://wptavern.com/13-vagrant-resources-for-wordpress-development)?
4141

@@ -47,7 +47,7 @@ Our **GOAL** is to be:
4747

4848
And one more goal we achieved is that our box supports **PhpStorm+XDEBUG debugging** with the least effort required on your part.
4949

50-
We think that once you try WPLib Box you will agree that we have succeeded. Want to know [**how**](#how) we did it?
50+
We think that once you try WPLib Box you will agree that we have succeeded. Want to know [**how**](# how) we did it?
5151

5252
<a id="whats-included"></a>
5353
## Services & Software Included
@@ -86,7 +86,7 @@ Since WPLib Box is distributed as a virtual machine image of a 64-bit distributi
8686

8787
<a id="for-mac"></a>
8888
<a id="for-linux"></a>
89-
###For Mac & Linux Users
89+
### For Mac & Linux Users
9090

9191
To run WPLib Box requires the following software be installed:
9292

@@ -96,17 +96,17 @@ To run WPLib Box requires the following software be installed:
9696
- Install the [Vagrant Triggers](https://github.com/emyl/vagrant-triggers) plugin by running `vagrant plugin install vagrant-triggers`
9797

9898
<a id="for-windows"></a>
99-
###For Windows Users
99+
### For Windows Users
100100

101101
- Install everything from the Mac & Linux Users list above
102102
- Ensure that no other VM platform is running (either VMware or Hyper-V) as they will prevent VirtualBox from operating.
103103
- Install [Git](https://git-scm.com/downloads) version 2 or greater **OR** download the `.ZIP` file and unzip instead.
104104

105105
<a id="quickstart"></a>
106-
##Quickstart
106+
## Quickstart
107107
After making sure you have the necessary software, run the following commands
108108

109-
###For Mac or Linux users:
109+
### For Mac or Linux users:
110110

111111
# cd ~/Sites, or cd into whichever directory you store your website projects in
112112
cd ~/Sites
@@ -115,7 +115,7 @@ After making sure you have the necessary software, run the following commands
115115
vagrant up
116116
open "http://wplib.box"
117117

118-
###For Windows users:
118+
### For Windows users:
119119

120120
# cd into whichever directory you store your website projects in.
121121
# For example, your user profile: C:\Users\{current user}\Sites
@@ -132,7 +132,7 @@ After making sure you have the necessary software, run the following commands
132132
After this you should have a running WPLib Box via Vagrant and VirtualBox and a website loaded at the local `wplib.box` domain.
133133

134134
<a id="setting-domain"></a>
135-
##Setting the Domain Name
135+
## Setting the Domain Name
136136

137137
To use WPLib Box for a local domain name other than `wplib.box` edit the `HOSTNAME` file _(with no extension)_
138138
and replace the text `"wplib.box"` with your preferred local domain name _(we recommend `"your-production-2nd-level-domain.dev"` e.g. if `google.com` then use `google.dev`):_
@@ -160,7 +160,7 @@ If you need to change that for any reason simply **edit the file named just `IP`
160160

161161
<a id="web-php"></a>
162162
## Default PHP Version for the Web
163-
The default version fot the web is `7.0.x`. Instructions to [switch to PHP 5.6](FAQ.md#switch-php) are on our FAQ.
163+
The default version fot the web is `7.0.x`. Instructions to [switch to PHP 5.6](FAQ.md# switch-php) are on our FAQ.
164164

165165
<a id="switching-php"></a>
166166
## Switching PHP Versions
@@ -233,7 +233,7 @@ There is no `root` user _per-se_ in WPLib Box, only the `vagrant` user. You have
233233
<a id="xdebug"></a>
234234
## Debugging PHP with XDEBUG and PhpStorm
235235

236-
See instructions [**here**](https://github.com/wplib/connect.tech-atlanta-2016/blob/master/debugging-with-phpstorm-xdebug.md#debugging-with-phpstorm-and-xdebug).
236+
See instructions [**here**](https://github.com/wplib/connect.tech-atlanta-2016/blob/master/debugging-with-phpstorm-xdebug.md# debugging-with-phpstorm-and-xdebug).
237237

238238
<a id="internet-sharing"></a>
239239
## Internet Sharing
@@ -243,11 +243,11 @@ Internet sharing is implemented with [localtunnel.me](https://localtunnel.me), w
243243
<a id="troubleshooting"></a>
244244
## Troubleshooting
245245

246-
If you are having trouble with WPLib Box please check out our Troubleshooting section of our [**FAQ**](FAQ.md#troubleshooting) and/or you can also [reach out to our support team](FAQ.md#support) for **quick help** on Slack and via other channels.
246+
If you are having trouble with WPLib Box please check out our Troubleshooting section of our [**FAQ**](FAQ.md# troubleshooting) and/or you can also [reach out to our support team](FAQ.md# support) for **quick help** on Slack and via other channels.
247247

248248

249249
<a id="how-best"></a>
250-
##How are we the Best?
250+
## How are we the Best?
251251

252252
How have we been able to make **WPLib Box** the:
253253

@@ -279,13 +279,13 @@ Give it a try and see if you don't agree.
279279
- [**WPLib Box Maker**](https://github.com/ArtOfWP/generator-wplibbox) from [ArtOfWP](https://github.com/ArtOfWP): _Generates a custom WPLib Box setup using [Yeoman](http://yeoman.io/)._
280280

281281
<a id="issues-status"></a>
282-
##Status of Issues
282+
## Status of Issues
283283
We are using Waffle.io to help us manage our GitHub issue queue:
284284

285285
[![Stories in Ready](https://badge.waffle.io/wplib/wplib-box.png?label=ready&title=Ready)](https://waffle.io/wplib/wplib-box)
286286
[![Stories In Progress](https://badge.waffle.io/wplib/wplib-box.svg?label=in+progress&title=In+Progress)](http://waffle.io/wplib/wplib-box)
287287

288288
<a id="future-plans"></a>
289-
##Future Plans
289+
## Future Plans
290290

291291
We have many plans for the WPLib platform. This is just a start. Watch this repo to keep up to date.

0 commit comments

Comments
 (0)