github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Rework the --static documentation

Browse source 
Rework the `--static` documentation to better differentiate between the filesystem and serving locations. Closes #1457

Co-authored-by: Simon Willison <swillison@gmail.com>
This commit is contained in:
C. Titus Brown 2021-10-14 11:39:55 -07:00 • committed by GitHub
commit 0fdbf00484
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/custom_templates.rst
View file

@ -173,18 +173,18 @@ Datasette can serve static files for you, using the ``--static`` option.
Consider the following directory structure:: Consider the following directory structure::
metadata.json metadata.json
static/styles.css static-files/styles.css
static/app.js static-files/app.js
You can start Datasette using ``--static static:static/`` to serve those You can start Datasette using ``--static assets:static-files/`` to serve those
files from the ``/static/`` mount point:: files from the ``/assets/`` mount point::
$ datasette -m metadata.json --static static:static/ --memory $ datasette -m metadata.json --static assets:static-files/ --memory
The following URLs will now serve the content from those CSS and JS files:: The following URLs will now serve the content from those CSS and JS files::
http://localhost:8001/static/styles.css http://localhost:8001/assets/styles.css
http://localhost:8001/static/app.js http://localhost:8001/assets/app.js
You can reference those files from ``metadata.json`` like so: You can reference those files from ``metadata.json`` like so:
@ -192,10 +192,10 @@ You can reference those files from ``metadata.json`` like so:
{ {
"extra_css_urls": [ "extra_css_urls": [
"/static/styles.css" "/assets/styles.css"
], ],
"extra_js_urls": [ "extra_js_urls": [
"/static/app.js" "/assets/app.js"
] ]
} }
@ -205,10 +205,10 @@ Publishing static assets
The :ref:`cli_publish` command can be used to publish your static assets, The :ref:`cli_publish` command can be used to publish your static assets,
using the same syntax as above:: using the same syntax as above::
$ datasette publish cloudrun mydb.db --static static:static/ $ datasette publish cloudrun mydb.db --static assets:static-files/
This will upload the contents of the ``static/`` directory as part of the This will upload the contents of the ``static-files/`` directory as part of the
deployment, and configure Datasette to correctly serve the assets. deployment, and configure Datasette to correctly serve the assets from ``/assets/``.
.. _customization_custom_templates: .. _customization_custom_templates: