Document usage of docker

This commit is contained in:
Stéphane Goetz 2017-09-13 22:47:53 +02:00
parent 171674ffb6
commit 4a9a477c02
2 changed files with 46 additions and 5 deletions

View File

@ -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:

View File

@ -2,9 +2,12 @@
<strong>Daux.io</strong> 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.
</p>
<hr/>
<h3>Features</h3>
<hr/>
---
### Features
---
<div class=row>
<div class=col-third>
@ -45,7 +48,27 @@
</div>
</div>
<hr/>
---
### 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
```
---
<!-- Google Code -->
<script type="text/javascript">