TailwindCSS插件为Pelican 🌬

此插件帮助您在Pelican网站中使用TailwindCSS。

为什么使用此插件？

因为您希望在几秒钟内使用TailwindCSS。而不是几个小时。

要求

为了运行此插件，您需要安装NodeJS。（我正在寻找通过使用Python包来替换此依赖项。– Luca）

安装

此插件可以通过以下方式安装

python -m pip install pelican-tailwindcss

或者

poetry add pelican-tailwindcss

基本用法

1. 在您的Pelican项目根目录中创建一个tailwind.config.js文件，包含

   /** @type {import('tailwindcss').Config} */
   module.exports = {
   content: ["./themes/**/*.html", "./themes/**/*.js"],
   theme: {
       extend: {},
   },
   plugins: [],
   };
   

   内容属性的值仅作建议。请根据您的需求自由修改。

2. 在您的Pelican项目根目录中创建一个input.css文件，包含

   @tailwind base;
   @tailwind components;
   @tailwind utilities;
   

3. 在您的base.html中添加构建文件（output.css）。

   <link rel="stylesheet" href="/output.css" />
   

4. 完成！您应该准备好在您的网站模板中使用 TailwindCSS。

高级用法

在您的设置中，您可以使用 TAILWIND 设置来配置插件的行为。

一个完整的 TAILWIND 设置示例

TAILWIND = {
    "version": "3.0.0",
    "plugins": [
        "@tailwindcss/typography",
        "@tailwindcss/forms",
        "@tailwindcss/line-clamp",
        "@tailwindcss/aspect-ratio",
    ],
}

Tailwind 插件安装

如上例所示，您可以将 plugins 属性添加到配置中。只需将 Tailwind 插件名称添加到该属性，插件就会安装。

有用信息

插件

当 Pelican 启动时，才会复制您的 tailwind.config.js 文件。这意味着启动 Pelican 后的任何更改都不会被考虑。例如，如果您想为 Tailwind 安装一个新的插件，您将需要重新启动 Pelican。

贡献

欢迎并非常感谢贡献。每一份贡献都很有帮助。您可以通过改进文档、添加缺失的功能和修复错误来贡献。您还可以通过审阅和评论 现有问题 来提供帮助。

要开始为该插件做出贡献，请查阅 为 Pelican 做出贡献 的文档，从 代码贡献 部分开始。

许可证

本项目采用 AGPL-3.0 许可协议。