From 4a9a477c02532916b93ef13e37a0d3d1683e4636 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Goetz?= Date: Wed, 13 Sep 2017 22:47:53 +0200 Subject: [PATCH] Document usage of docker --- docs/00_Getting_Started.md | 20 +++++++++++++++++++- docs/_index.md | 31 +++++++++++++++++++++++++++---- 2 files changed, 46 insertions(+), 5 deletions(-) diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md index f95b173..8ac8d69 100644 --- a/docs/00_Getting_Started.md +++ b/docs/00_Getting_Started.md @@ -49,14 +49,32 @@ Do you use Daux.io? Send us a pull request or open an [issue](https://github.com ### Install -``` +#### PHP and Composer + +If you have PHP and Composer installed, you can install the dependency + +```bash composer global require dauxio/daux.io + +# Next to your `docs` folder, run +daux generate ``` You can then use the `daux` command line to generate your documentation. If the command isn't found, ensure your `$PATH` contains `~/.composer/vendor/bin` +#### Docker + +Or if you wish to use Docker, the start of the command will be : + +```bash +docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux +``` + +Any parameter valid in the PHP version is valid in the Docker version + + ### Writing pages Creating new pages is very easy: diff --git a/docs/_index.md b/docs/_index.md index 5c22df4..1edee1c 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -2,9 +2,12 @@ Daux.io is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

-
-

Features

-
+--- + +### Features + +--- +
@@ -45,7 +48,27 @@
-
+--- + +### Installation and usage + +If you have __PHP__ and Composer installed + +```bash +composer global require dauxio/daux.io + +# Next to your `docs` folder, run +daux generate +``` + +Or if you wish to use __Docker__ + +```bash +# Next to your `docs` folder, run +docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux generate +``` + +---