dblotsky commented on a change in pull request #800: document jekyll configuration in `conf` URL: https://github.com/apache/cordova-docs/pull/800#discussion_r171930889
########## File path: 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/ Review comment: I'd vote for putting this line in the top paragraph, and making it bold. :) ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org For additional commands, e-mail: commits-h...@cordova.apache.org
