Static files in templates in Django

Introduction

Static files like images, CSS, and JavaScript make your web pages look good and work well. Django helps you include these files easily in your templates.

You want to add a logo image to your website header.

You need to apply styles using CSS files to your HTML pages.

You want to add interactive behavior with JavaScript files.

You want to organize your static files in one place for easy management.

Syntax

Django

{% load static %}
<img src="{% static 'path/to/file.jpg' %}" alt="description">
<link rel="stylesheet" href="{% static 'css/styles.css' %}">
<script src="{% static 'js/script.js' %}"></script>

Always start your template with {% load static %} to use the static tag.

The {% static %} tag helps build the correct URL for your static files.

Examples

This adds a logo image from the images folder inside your static files.

Django

{% load static %}
<img src="{% static 'images/logo.png' %}" alt="Site Logo">

This links a CSS file to style your page.

Django

{% load static %}
<link rel="stylesheet" href="{% static 'css/main.css' %}">

This includes a JavaScript file for page behavior.

Django

{% load static %}
<script src="{% static 'js/app.js' %}"></script>

Sample Program

This template loads static files: a CSS file for styles, an image for the logo, and a JavaScript file for behavior. It shows how to organize and include static files in a Django template.

Django

{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Static Files Example</title>
  <link rel="stylesheet" href="{% static 'css/styles.css' %}">
</head>
<body>
  <header>
    <img src="{% static 'images/logo.png' %}" alt="Site Logo">
    <h1>Welcome to My Site</h1>
  </header>
  <script src="{% static 'js/script.js' %}"></script>
</body>
</html>

Important Notes

Make sure your static files are placed in the correct folders inside your Django app or project.

During development, Django serves static files automatically, but in production, you need to configure your web server to serve them.

Use the {% static %} tag instead of hardcoding URLs to keep your code flexible.

Summary

Use {% load static %} at the top of your template to enable static file usage.

Use {% static 'path/to/file' %} to get the correct URL for static files.

Static files include images, CSS, and JavaScript that improve your website's look and behavior.

Practice

1. What is the purpose of using {% load static %} at the beginning of a Django template?

easy

A. To start a for loop in the template

B. To load dynamic content from the database

C. To include another template inside the current one

D. To enable the use of static files like images, CSS, and JavaScript in the template

Solution

1. Step 1: Understand the role of static files in Django templates

   Static files are images, CSS, and JavaScript that enhance the website's appearance and behavior.

2. Step 2: Recognize the function of {% load static %}

   This tag loads the static template tag library, enabling the use of {% static %} to reference static files correctly.

3. Final Answer:

   To enable the use of static files like images, CSS, and JavaScript in the template -> Option D

4. Quick Check:

   Load static = enable static files [OK]

Hint: Remember: load static must be at the top to use static files [OK]

Common Mistakes:

• Forgetting to add {% load static %} before using {% static %}
• Confusing static files with dynamic content
• Using {% load static %} in views instead of templates

2. Which of the following is the correct syntax to include a CSS file named styles.css located in the static folder inside a Django template?

easy

A.

B.

C.

D.

Solution

1. Step 1: Recall the correct way to reference static files in Django templates

   Use the {% static 'path/to/file' %} tag after loading static files with {% load static %}.

2. Step 2: Identify the correct syntax for linking CSS

   The correct syntax uses {% static 'styles.css' %} inside the href attribute.

3. Final Answer:

   <link href="{% static 'styles.css' %}" rel="stylesheet"> -> Option A

4. Quick Check:

   Use {% static 'file' %} for static URLs [OK]

Hint: Use {% static 'file' %} inside href for static files [OK]

Common Mistakes:

• Using raw paths without {% static %} tag
• Using {{ static() }} which is invalid
• Trying to load static inside the href attribute

3. Given the template code below, what will be the rendered HTML output if the static file URL for images/logo.png is /static/images/logo.png?

{% load static %}

medium

A.

B.

C.

D.

Solution

1. Step 1: Understand the role of {% static %} tag

   The {% static %} tag converts the file path into the correct URL for static files, here it becomes /static/images/logo.png.

2. Step 2: Determine the final rendered HTML

   The template renders the img tag with src set to the static URL, so the output is <img src="/static/images/logo.png" alt="Logo">.

3. Final Answer:

   <img src="/static/images/logo.png" alt="Logo"> -> Option B

4. Quick Check:

   Static tag outputs correct URL [OK]

Hint: Static tag outputs full static URL in rendered HTML [OK]

Common Mistakes:

• Expecting the template tag to appear in output
• Confusing static URL with media URL
• Omitting {% load static %} causing errors

4. You wrote this Django template code to include a JavaScript file but it does not load correctly:

{% load static %}

What is the error and how can you fix it?

medium

A. Missing {% load static %} tag; add it at the top

B. Wrong file path; fix by changing src to /static/js/app.js

C. Missing {% static %} tag; fix by changing src to {% static 'js/app.js' %}

D. JavaScript files cannot be loaded this way in Django

Solution

1. Step 1: Identify the incorrect static file reference

   The src attribute uses a raw path "static/js/app.js" without the {% static %} tag, so Django won't resolve it correctly.

2. Step 2: Correct the syntax to use {% static %} tag

   Use src="{% static 'js/app.js' %}" to let Django generate the correct URL.

3. Final Answer:

   Missing {% static %} tag; fix by changing src to {% static 'js/app.js' %} -> Option C

4. Quick Check:

   Use {% static %} for static file URLs [OK]

Hint: Always wrap static file paths with {% static 'path' %} [OK]

Common Mistakes:

• Using raw paths without {% static %}
• Forgetting to load static tag
• Assuming /static/ prefix works automatically

5. You want to include an image and a CSS file in your Django template. The image is at images/photo.jpg and the CSS file is at css/style.css inside your static folder. Which template code correctly includes both files?

hard

A. {% load static %}

B. {% load static %}

C.

D. {% load static %}

Solution

1. Step 1: Ensure {% load static %} is included at the top

   This is required to use the {% static %} tag in the template.

2. Step 2: Use {% static %} tag to reference both image and CSS files

   Both src and href attributes must use {% static 'path' %} to generate correct URLs.

3. Final Answer:

   {% load static %} <img src="{% static 'images/photo.jpg' %}" alt="Photo"> <link rel="stylesheet" href="{% static 'css/style.css' %}"> -> Option A

4. Quick Check:

   Load static + use {% static %} for all static files [OK]

Hint: Always load static and use {% static 'file' %} for all static files [OK]

Common Mistakes:

• Omitting {% load static %} tag
• Using raw paths without {% static %}
• Mixing static and media URLs