Small configuration and documentation changes

This commit is contained in:
Stéphane Goetz 2017-09-13 23:27:19 +02:00
parent 1f84f500c1
commit c177ce3adc
3 changed files with 18 additions and 3 deletions

View File

@ -49,14 +49,29 @@ Do you use Daux.io? Send me 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
```
## Run on a server
Download this repository as a zip, unpack, and put your documentation in the `docs` folder, you can then serve it with Apache or Nginx.

View File

@ -22,7 +22,7 @@
"repo": "dauxio/daux.io",
"edit_on_github": "dauxio/daux.io/blob/master/docs",
"twitter": ["onigoetz"],
"google_analytics": "UA-12653604-10",
"google_analytics": "UA-3551397-7",
"links": {
"Download": "https://github.com/dauxio/daux.io/archive/master.zip",
"GitHub Repo": "https://github.com/dauxio/daux.io",

View File

@ -18,7 +18,7 @@ var resources = {
var stylelintRules = {
"indentation": 4,
"selector-list-comma-newline-after": "always-multi-line",
"selector-no-id": true,
"selector-max-id": 0,
// Autoprefixer
"at-rule-no-vendor-prefix": true,