Skip to content

Commit

Permalink
Small configuration and documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
onigoetz committed Sep 13, 2017
1 parent 1f84f50 commit c177ce3
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit c177ce3

Please sign in to comment.