diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst index 5a0cffe65..d1d36324a 100644 --- a/docs/project-generation-options.rst +++ b/docs/project-generation-options.rst @@ -73,7 +73,9 @@ js_task_runner [1] 3. None custom_bootstrap_compilation [n] - If you use Grunt, scaffold out recompiling Bootstrap as as task. (Useful for letting you change Bootstrap variables in real time.) Consult project README for more details. + Scaffold out recompiling Bootstrap as as task, with Gulp_ or Grunt_. + Useful for letting you change Bootstrap variables in real time. + Consult project README for more details. open_source_license [1] Select a software license for the project. The choices are: diff --git a/{{cookiecutter.project_slug}}/README.rst b/{{cookiecutter.project_slug}}/README.rst index 924e238dd..bc3474c4e 100644 --- a/{{cookiecutter.project_slug}}/README.rst +++ b/{{cookiecutter.project_slug}}/README.rst @@ -142,15 +142,23 @@ Elastic Beanstalk See detailed `cookiecutter-django Elastic Beanstalk documentation`_. -.. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-elastic-beanstalk.html +.. _`cookiecutter-django Elastic Beanstalk documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-elastic-beanstalk.html {% endif %} {% if cookiecutter.custom_bootstrap_compilation == "y" %} Custom Bootstrap Compilation ^^^^^^ -To get automatic Bootstrap recompilation with variables of your choice, install bootstrap sass (`bower install bootstrap-sass`) and tweak your variables in `static/sass/custom_bootstrap_vars`. +The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice. +Bootstrap v4 is installed using npm and customised by tweaking your variables in ``static/sass/custom_bootstrap_vars``. -(You can find a list of available variables [in the bootstrap-sass source](https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/bootstrap/_variables.scss), or get explanations on them in the [Bootstrap docs](https://getbootstrap.com/customize/).) +You can find a list of available variables `in the bootstrap source`_, or get explanations on them in the `Bootstrap docs`_. + +{% if cookiecutter.js_task_runner == 'Gulp' %} +Bootstrap's javascript as well as its dependencies is concatenated into a single file: ``static/js/vendors.js``. +{% endif %} + +.. _in the bootstrap source: https://github.com/twbs/bootstrap/blob/v4-dev/scss/_variables.scss +.. _Bootstrap docs: https://getbootstrap.com/docs/4.0/getting-started/theming/ {% endif %}