首页
/ django-htmlmin 技术文档

django-htmlmin 技术文档

2024-12-25 10:26:01作者：幸俭卉
django-htmlmin
HTML minifier for Python frameworks (not only Django, despite the name).
项目地址：https://gitcode.com/gh_mirrors/dj/django-htmlmin

1. 安装指南

首先，确保您的环境中已安装pip。然后，通过以下命令安装django-htmlmin：

$ [sudo] pip install django-htmlmin

如果您使用的是虚拟环境，请确保在正确的环境中运行上述命令。

2. 项目使用说明

2.1 中间件使用

要将django-htmlmin集成到您的Django项目中，您需要在settings.py文件中配置中间件。以下是配置步骤：

  1. 将以下两个中间件添加到MIDDLEWARE_CLASSES（或MIDDLEWARE，取决于Django版本）设置中：

    MIDDLEWARE_CLASSES = (
    # 其他中间件类
    'htmlmin.middleware.HtmlMinifyMiddleware',
    'htmlmin.middleware.MarkRequestMiddleware',
)

  2. 启用HTML_MINIFY设置：

    HTML_MINIFY = True

默认情况下，HTML_MINIFY的值是not DEBUG。如果您希望在DEBUG模式下启用HTML压缩，则需要将其设置为True。

2.2 排除特定URL

如果您不希望压缩应用中所有视图的HTML，可以通过添加EXCLUDE_FROM_MINIFYING设置在settings.py中指定不压缩的URL模式。

EXCLUDE_FROM_MINIFYING = ('^my_app/', '^admin/')

2.3 保持注释

默认情况下，中间件会删除所有HTML注释。如果您希望保留注释，请设置KEEP_COMMENTS_ON_MINIFYING为True：

KEEP_COMMENTS_ON_MINIFYING = True

2.4 保守空白压缩

默认情况下，压缩器会智能地删除空白字符，仅在需要保持内联文本渲染时留下空格。如果您希望将所有空白字符减少为一个空格而不完全删除，请设置CONSERVATIVE_WHITESPACE_ON_MINIFYING为False：

CONSERVATIVE_WHITESPACE_ON_MINIFYING = True

3. 项目API使用文档

3.1 装饰器使用

django-htmlmin提供了一个装饰器minified_response，您可以将其应用于需要压缩响应的视图：

from htmlmin.decorators import minified_response

@minified_response
def home(request):
    return render_to_response('home.html')

如果需要避免特定响应被压缩，可以使用not_minified_response装饰器，而不使用EXCLUDE_FROM_MINIFYING设置：

from htmlmin.decorators import not_minified_response

@not_minified_response
def home(request):
    return render_to_response('home.html')

3.2 html_minify函数使用

如果您不是在使用Django，可以手动调用html_minify函数压缩HTML：

from htmlmin.minify import html_minify
html = '<html>    <body>Hello world</body>    </html>'
minified_html = html_minify(html)

对于Flask视图，可以如下使用：

from flask import Flask
from htmlmin.minify import html_minify

app = Flask(__name__)

@app.route('/')
def home():
    rendered_html = render_template('home.html')
    return html_minify(rendered_html)

3.3 保持注释

默认情况下，html_minify()会删除所有注释。如果您希望保留它们，请传递ignore_comments=False参数：

from htmlmin.minify import html_minify
html = '<html>  <body>Hello world<!-- comment to keep --></body>  </html>'
minified_html = html_minify(html, ignore_comments=False)

4. 项目安装方式

请遵循上述安装指南，使用pip安装django-htmlmin。如果您需要从源代码安装，请确保从GitHub克隆存储库并运行setup.py脚本。

$ git clone https://github.com/cobrateam/django-htmlmin.git
$ cd django-htmlmin
$ python setup.py install

以上就是django-htmlmin的详细技术文档，希望能够帮助您更好地了解和使用该项目。

django-htmlmin
HTML minifier for Python frameworks (not only Django, despite the name).
项目地址：https://gitcode.com/gh_mirrors/dj/django-htmlmin

相关内容推荐

1 hugulp 项目教程2 Django-treenav 技术文档3 Django-Markup技术文档4 Django Pipeline 技术文档5 Django-Tastypie 技术文档6 Django-Authority 项目技术文档7 Django-Hstore 技术文档8 Django-Test-Utils 技术文档9 Django Categories 技术文档10 Django-Phonenumber-Field 技术文档
热门项目推荐
相关项目推荐

热门内容推荐

1 开发者路线图项目教程2 Vue.js 教程与指南3 探索Vue 2的持久魅力：一个开源项目的深度解析4 开源项目 `awesome-selfhosted` 使用教程5 TensorFlow 开源项目指南6 TensorFlow 开源项目教程7 TensorFlow：开启机器学习新纪元8 推荐项目：探索 Linux 内核的奥秘9 开源项目指南：Linux 内核10 Linux内核项目技术文档

最新内容推荐

Python JSON Patch 库技术文档 py-moneyed 技术文档 Python-Google-Places 技术文档 python-registry 技术文档 Django Address 技术文档 libfitbit 技术文档 PyStun 技术文档 PlayOnLinux 和 PlayOnMac 4 技术文档 PackageDev 技术文档 Shopify Django App示例项目技术文档

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！
C
48
38
PDFMathTranslatePDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译，支持 Google/DeepL/Ollama/OpenAI 等服务，提供 CLI/GUI/Docker
Python
31
3
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件，采用集群高扩展架构，通过应用备份通用框架、并行备份等技术，为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力，帮助用户实现关键数据高效保护。
HTML
69
51
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
173
39
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot，Spring Security，JWT，Vue & Element 的前后端分离权限管理系统，同时提供了 Vue3 的版本
Java
165
34
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码，欢迎大家投稿，在仓颉鸿蒙社区展现你的妙趣设计！
Cangjie
249
63
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
25
17
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
892
0
smart-adminsmart-admin
SmartAdmin国内首个以「高质量代码」为核心，「简洁、高效、安全」中后台快速开发平台；基于SpringBoot2/3 + Sa-Token + Mybatis-Plus 和 Vue3 + Vite5 + Ant Design Vue 4.x (同时支持JavaScript和TypeScript双版本)；满足国家三级等保要求、支持登录限制、接口数据国产加解密、高防SQL注入等一系列安全体系。
Java
19
3
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台，旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块，支持多种类型的测试用例，目前支持API(http和grpc协议)、性能、CI调用等功能，并且可定制化，灵活满足不同场景的需求。 其中，支持批量执行、并发执行等高级功能。通过用例设置，可以设置用例的基本信息、运行配置、环境变量等，灵活控制用例的执行。
JavaScript
11
2