[cordova-docs] 01/01: document `conf` a bit

[ja...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

janpio pushed a commit to branch janpio-document_jekyll_a_bit
in repository https://gitbox.apache.org/repos/asf/cordova-docs.git

commit a1561a5af74344d0ceaafefa34e481820ab00636
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Fri Mar 2 19:05:52 2018 +0100

    document `conf` a bit
---
 conf/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/conf/README.md b/conf/README.md
new file mode 100644
index 0000000..c2bdba9
--- /dev/null
+++ b/conf/README.md
@@ -0,0 +1,17 @@
+# Jekyll Configuration
+
+This folder contains different configuration files for the Jekyll build which is triggered via `gulp build` and similar commands (`gulp serve` etc.).
+
+Files present after checkout:
+
+- `_config.yml` is the main Jekyll config file
+- `_version.yml` defines the latest version of the docs
+- `_dev.yml` is used for normal builds
+- `_prod.yml` is used when the `--prod` option is used for the build
+- `_nodocs.yml` is used when the `--nodocs` option is used for the build
+
+Some files are generated by the build process itself:
+
+- `_defaults.yml` defines different config values for different parts of the docs
+
+To learn more about how to control the build with these files, have a look at: https://jekyllrb.com/docs/configuration/
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
janpio@apache.org.

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org