首页
/ dotless 项目技术文档

dotless 项目技术文档

2024-12-23 05:36:28作者:庞眉杨Will

1. 安装指南

1.1 通过 NuGet 安装

dotless 提供了多个 NuGet 包,用户可以根据需求选择合适的包进行安装:

  • dotless.Core: 提供 Less 编译器核心功能。
  • dotless.AspNetHandler: 提供 ASP.NET 处理程序,用于在运行时编译 Less 文件。
  • dotless: 包含 Core 和 ASP.NET Handler 的向后兼容包。如果不需要 ASP.NET 功能,建议升级到 dotless.AspNetHandler 或 dotless.Core。
  • dotless.CLI: 提供命令行接口,用于编译 Less 文件。

安装命令示例:

dotnet add package dotless.Core --version 1.6.7

1.2 通过 GitHub 下载

如果只需要 .dll 文件,可以直接从 GitHub 下载编译好的发布版本。访问 GitHub 下载页面,选择最新的成功构建版本,点击 "Artifacts" 部分,即可获取最新的编译器 exe 和所需的 dll 文件。

1.3 .NET Framework 版本支持

dotless 从 1.6 版本开始支持以下 .NET Framework 版本:

  • .NET Framework 4.5.1
  • .NET Framework 4.6.1
  • .NET Framework 4.7
  • .NET Standard 2.0(.NET Core 2.0, Mono 5.4, .NET Framework 4.6.1+)

如果应用程序或库不支持上述框架,请使用 1.5.3 版本。

2. 项目的使用说明

2.1 基本功能

dotless 是一个将 Less 库移植到 .NET 世界的项目。它为 CSS 提供了变量、嵌套规则和运算符等功能。

2.2 使用场景

  • Web 开发: 通过 dotless.AspNetHandler 在 ASP.NET 应用程序中动态编译 Less 文件。
  • 命令行工具: 使用 dotless.CLI 在命令行中编译 Less 文件。
  • 核心功能: 使用 dotless.Core 在任何 .NET 项目中集成 Less 编译功能。

2.3 示例代码

以下是一个简单的 Less 文件示例:

@base-color: #333;

body {
  color: @base-color;
  background-color: lighten(@base-color, 50%);
}

使用 dotless 编译后,生成的 CSS 文件如下:

body {
  color: #333;
  background-color: #999;
}

3. 项目 API 使用文档

3.1 dotless.Core API

dotless.Core 提供了核心的 Less 编译功能。以下是一些常用的 API 方法:

  • Compile(string lessContent): 编译 Less 字符串并返回 CSS 字符串。
  • CompileFile(string lessFilePath): 编译指定路径的 Less 文件并返回 CSS 字符串。

示例代码:

using dotless.Core;

string lessContent = "@base-color: #333; body { color: @base-color; }";
string cssContent = Less.Compile(lessContent);

3.2 dotless.AspNetHandler API

dotless.AspNetHandler 提供了 ASP.NET 处理程序,用于在运行时编译 Less 文件。以下是一些常用的 API 方法:

  • ProcessRequest(HttpContext context): 处理 HTTP 请求并返回编译后的 CSS 内容。

示例代码:

using dotless.AspNetHandler;

public class LessHandler : IHttpHandler
{
    public void ProcessRequest(HttpContext context)
    {
        var handler = new LessHandler();
        handler.ProcessRequest(context);
    }
}

4. 项目安装方式

4.1 通过 NuGet 安装

使用以下命令安装 dotless 包:

dotnet add package dotless.Core --version 1.6.7

4.2 通过 GitHub 下载

访问 GitHub 下载页面,选择最新的成功构建版本,点击 "Artifacts" 部分,即可获取最新的编译器 exe 和所需的 dll 文件。

4.3 通过 Visual Studio 安装

在 Visual Studio 中,打开“工具” -> “NuGet 包管理器” -> “管理解决方案的 NuGet 包”,搜索 dotless.Core 并安装。

通过以上步骤,您可以轻松安装并使用 dotless 项目,享受 Less 带来的便利。

登录后查看全文
热门项目推荐