Generate HTML documentation using MkDocs (WIP)

[github/shaarli/Shaarli.git] / doc / md / Unit-tests.md

diff --git a/doc/Unit-tests.md b/doc/md/Unit-tests.md
similarity index 96%
rename from doc/Unit-tests.md
rename to doc/md/Unit-tests.md
index 0942ad382fd18f0b4f976f22fb560bb9e22c7842..1983872193bfd861129de6698cefa6eef05087b0 100644 (file)
--- a/doc/Unit-tests.md
+++ b/doc/md/Unit-tests.md
@@ -1,13 +1,13 @@
-#Unit tests
-
 ### Setup your environment for tests
-The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool.[](.html)
+
+The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool.
 
 Regarding Composer, you can either use:
 * a system-wide version, e.g. installed through your distro's package manager
-* a local version, downloadable [here](https://getcomposer.org/download/)[](.html)
+* a local version, downloadable [here](https://getcomposer.org/download/)
 
 #### Sample usage
+
 ```bash
 # system-wide version
 $ composer install
@@ -20,12 +20,14 @@ $ php composer.phar update
 ```
 
 #### Install Shaarli dev dependencies
+
 ```bash
 $ cd /path/to/shaarli
 $ composer update
 ```
 
 #### Install and enable Xdebug to generate PHPUnit coverage reports
+
 For Debian-based distros:
 ```bash
 $ aptitude install php5-xdebug
@@ -41,6 +43,7 @@ zend_extension=xdebug.so
 ```
 
 #### Run unit tests
+
 Successful test suite:
 ```bash
 $ make test
@@ -111,6 +114,7 @@ Tests: 36, Assertions: 63, Errors: 1, Failures: 2.
 ```
 
 #### Test results and coverage
+
 By default, PHPUnit will run all suitable tests found under the `tests` directory.
 
 Each test has 3 possible outcomes:
@@ -128,7 +132,8 @@ If Xdebug has been installed and activated, two coverage reports will be generat
  * to open it in a web browser: `firefox coverage/index.html &`
 
 ### Executing specific tests
-Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment:[](.html)
+
+Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment:
 
 ```php
 /**
@@ -137,7 +142,7 @@ Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.htm
  */
 class BookmarkImportTest extends PHPUnit_Framework_TestCase
 {
-   [...][](.html)
+   [...]
 }
 ```