diff --git a/README.md b/README.md index 6e109e6..2c7e363 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # deployment-helper für Nikola based Websites -# ENV-Variables +## ENV-Variables * LFTP_PASSWORD (Deployment-Passwort for sftp-Upload) * SSH_HOST (Deployment-Host for sftp-Upload) @@ -13,13 +13,24 @@ Python-packages for building nikola-sites. ## Configure your project -Create a configuration file in your git-repo: `.deployment-helper` +| Variable | Default | Description | +| --------------------------- | --------------- | ---------------------------------------- | +| DEPLOY_HELPER_ENABLE_NIKOLA | true | Build Nikola-Website in `website/` | +| DEPLOY_HELPER_ENABLE_NODE | false | Enable nodejs Build in `node/` | +| DEPLOY_HELPER_CONTENT_DIR | website/output/ | Default Content-Directory for publishing | -Configuration-Variables: -* DEPLOY_HELPER_ENABLE_NIKOLA (default: true) -* DEPLOY_HELPER_ENABLE_NODE (default: false) -* DEPLOY_HELPER_CONTENT_DIR (default: "website/output") +Create a configuration file in your git-repo: `.deployment-helper`: + +``` +DEPLOY_HELPER_ENABLE_NIKOLA=false +DEPLOY_HELPER_ENABLE_NODE=true +DEPLOY_HELPER_CONTENT_DIR="node/.output/public/" +``` + +This example disables the niko build and enables node. The finished +website is copied from the `node/.output/public/` directory to the +target server. ## lftp for sftp-Uploads