Django-Static 技术文档

1. 安装指南

首先，确保您已经安装了 Django。然后，通过以下命令将 django-static 添加到您的项目中：

pip install django-static

在您的项目的 settings.py 文件中，添加 'static' 到 INSTALLED_APPS 列表中：

INSTALLED_APPS = [
    # ...
    'static',
    # ...
]

确保 django-static 被正确添加到应用列表中。

2. 项目的使用说明

django-static 是一个 Django 应用程序，提供了五个模板标签来更好地服务静态内容：

• staticfile
• slimfile
• slimcontent
• staticall
• slimall

这些标签可以帮助您优化静态文件的引用，并在必要时进行压缩和合并。

使用示例

• 使用 staticfile 标签为静态文件添加时间戳：

<img src="{% staticfile "/images/foo.png" %}"/>

• 使用 slimfile 压缩并重写 JavaScript 或 CSS 文件：

<script type="text/javascript"
  src="{% slimfile "/javascript/myscript.js" %}"></script>

• 使用 slimcontent 直接在模板中压缩内容：

<style type="text/css">
{% slimcontent "css" %}
h1, h2, h3 {
    font-face: 'Trebuchet MS', Verdana, Arial;
}
{% endslimcontent %}
</style>

• 使用 staticall 合并文件：

{% staticall %}
<script src="/javascript/foo.js"></script>
<script src="/javascript/bar.js"></script>
{% endstaticall %}

• 使用 slimall 压缩并合并文件：

{% slimall %}
<script src="/javascript/foo.js"></script>
<script src="/javascript/bar.js"></script>
{% endslimall %}

3. 项目API使用文档

django-static 的配置选项可以在 settings.py 中设置：

• DJANGO_STATIC：控制 django-static 是否激活。
• DJANGO_STATIC_SAVE_PREFIX：指定保存优化后的文件的目录。
• DJANGO_STATIC_NAME_PREFIX：为生成的文件名添加前缀。
• DJANGO_STATIC_MEDIA_URL：设置静态文件的 URL 前缀。
• DJANGO_STATIC_MEDIA_URL_ALWAYS：即使 DJANGO_STATIC 为 False 也使用 DJANGO_STATIC_MEDIA_URL。
• DJANGO_STATIC_MEDIA_ROOTS：指定静态文件的搜索目录。
• DJANGO_STATIC_USE_SYMLINK：控制是否使用符号链接而不是复制文件。
• DJANGO_STATIC_USE_MANIFEST_FILE：启用 manifest 文件以存储文件名。
• DJANGO_STATIC_FILE_PROXY：设置一个代理函数来处理静态 URI。
• DJANGO_STATIC_FILENAME_GENERATOR：设置自定义的文件名生成函数。
• DJANGO_STATIC_COMBINE_FILENAMES_GENERATOR：设置自定义的合并文件名生成函数。

4. 项目安装方式

如前所述，您可以通过 pip 命令安装 django-static。确保您的项目中已经安装了 Django，然后运行以下命令：

pip install django-static

之后，在 settings.py 文件中配置 django-static 的相关设置，并确保 'static' 被添加到 INSTALLED_APPS 列表中。这样，您就可以在 Django 项目中使用 django-static 的功能了。