From 83d4fbbc9acbcfd1008b778682cb6e9527dc3ed2 Mon Sep 17 00:00:00 2001 From: Will Roberts Date: Thu, 22 Jun 2017 10:29:27 +0200 Subject: [PATCH] README: make new section for asset management --- {{cookiecutter.app_name}}/README.rst | 40 ++++++++++++++++------------ 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/{{cookiecutter.app_name}}/README.rst b/{{cookiecutter.app_name}}/README.rst index 3ead74c..ca19550 100644 --- a/{{cookiecutter.app_name}}/README.rst +++ b/{{cookiecutter.app_name}}/README.rst @@ -40,23 +40,6 @@ database tables and perform the initial migration :: flask db upgrade flask run -Files placed inside the ``assets`` directory and its subdirectories -will be copied by webpack's ``file-loader`` into the ``static/build`` -directory, with hashes of their contents appended to their names. For -instance, if you have the file ``assets/img/favicon.ico``, this will -get copied into something like -``static/build/img/favicon.fec40b1d14528bf9179da3b6b78079ad.ico``. -You can then put this line into your header:: - - - -to refer to it inside your HTML page. If all of your assets are -managed this way, you can ask Flask to tell web browsers that they -should cache your static files forever by including the following line -in your ``settings.py``:: - - SEND_FILE_MAX_AGE_DEFAULT = 31556926 # one year - Deployment ---------- @@ -103,3 +86,26 @@ This will generate a new migration script. Then run :: To apply the migration. For a full migration command reference, run ``flask db --help``. + + +Asset Management +---------------- + +Files placed inside the ``assets`` directory and its subdirectories +(excluding ``js`` and ``css``) will be copied by webpack's +``file-loader`` into the ``static/build`` directory, with hashes of +their contents appended to their names. For instance, if you have the +file ``assets/img/favicon.ico``, this will get copied into something +like +``static/build/img/favicon.fec40b1d14528bf9179da3b6b78079ad.ico``. +You can then put this line into your header:: + + + +to refer to it inside your HTML page. If all of your static files are +managed this way, then their filenames will change whenever their +contents do, and you can ask Flask to tell web browsers that they +should cache all your assets forever by including the following line +in your ``settings.py``:: + + SEND_FILE_MAX_AGE_DEFAULT = 31556926 # one year