Small configuration and documentation changes
This commit is contained in:
bovenliggende
1f84f500c1
commit
c177ce3adc
17
README.md
17
README.md
|
@ -49,14 +49,29 @@ Do you use Daux.io? Send me a pull request or open an [issue](https://github.com
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```
|
### PHP and Composer
|
||||||
|
|
||||||
|
If you have PHP and Composer installed, you can install the dependency
|
||||||
|
|
||||||
|
```bash
|
||||||
composer global require dauxio/daux.io
|
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.
|
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`
|
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
|
## 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.
|
Download this repository as a zip, unpack, and put your documentation in the `docs` folder, you can then serve it with Apache or Nginx.
|
||||||
|
|
|
@ -22,7 +22,7 @@
|
||||||
"repo": "dauxio/daux.io",
|
"repo": "dauxio/daux.io",
|
||||||
"edit_on_github": "dauxio/daux.io/blob/master/docs",
|
"edit_on_github": "dauxio/daux.io/blob/master/docs",
|
||||||
"twitter": ["onigoetz"],
|
"twitter": ["onigoetz"],
|
||||||
"google_analytics": "UA-12653604-10",
|
"google_analytics": "UA-3551397-7",
|
||||||
"links": {
|
"links": {
|
||||||
"Download": "https://github.com/dauxio/daux.io/archive/master.zip",
|
"Download": "https://github.com/dauxio/daux.io/archive/master.zip",
|
||||||
"GitHub Repo": "https://github.com/dauxio/daux.io",
|
"GitHub Repo": "https://github.com/dauxio/daux.io",
|
||||||
|
|
|
@ -18,7 +18,7 @@ var resources = {
|
||||||
var stylelintRules = {
|
var stylelintRules = {
|
||||||
"indentation": 4,
|
"indentation": 4,
|
||||||
"selector-list-comma-newline-after": "always-multi-line",
|
"selector-list-comma-newline-after": "always-multi-line",
|
||||||
"selector-no-id": true,
|
"selector-max-id": 0,
|
||||||
|
|
||||||
// Autoprefixer
|
// Autoprefixer
|
||||||
"at-rule-no-vendor-prefix": true,
|
"at-rule-no-vendor-prefix": true,
|
||||||
|
|
Laden…
Verwijs in nieuw issue