astro-tips-pluss
v1.4.3
Published
🎨 Beautiful, customizable tip and notice blocks for Astro - 16 built-in styles with auto dark mode support and built-in compression
Maintainers
Readme
[Englis## 🏗️ 项目结构
项目采用模块化设计,便于维护和扩展:
src/
├── types.ts # TypeScript 类型定义
├── config.ts # 默认配置和常量
├── utils.ts # 工具函数和样式生成
├── remark-plugin.ts # Remark 插件核心逻辑
index.ts # 主入口文件
dist/ # 编译输出目录🎨 样式处理: 完全采用内联样式,无需外部CSS文件依赖,每个提示框都包含完整的样式定义和暗色主题支持。d)
🎨 Astro Tips Pluss - 美观的提示框集成
🌟 为 Astro 生态系统打造的提示框集成
让你的内容更加生动! astro-tips-pluss 是一个简单易用的 Astro 集成,只需几行代码就能在 Markdown 和 MDX 文件中创建 31 种精美的提示框。
🏗️ 项目结构
项目采用模块化设计,便于维护和扩展:
src/
├── types.ts # TypeScript 类型定义
├── config.ts # 默认配置和常量
├── utils.ts # 工具函数
└── remark-plugin.ts # Remark 插件核心逻辑
index.ts # 主入口文件
dist/ # 编译输出目录✨ 核心特性
- 🚀 零配置即用,开箱即用
- 🎨 31 种内置提示框类型,覆盖所有使用场景
- 🌙 自动适配亮色/暗色主题
- 📝 完全兼容 Markdown 语法
- ✨ 简单直观的使用方式
- 💎 完全内联样式,无需外部CSS文件
📦 快速安装
选择你喜欢的包管理器:
# 使用 bun (推荐)
bun add astro-tips-pluss
# 使用 npm
npm install astro-tips-pluss
# 使用 yarn
yarn add astro-tips-pluss
# 使用 pnpm
pnpm add astro-tips-pluss⚙️ 配置设置
基础配置(推荐)
在 astro.config.mjs 文件中添加集成,享受零配置的便利:
import { defineConfig } from 'astro/config';
import astroTips from 'astro-tips-pluss';
export default defineConfig({
integrations: [astroTips()], // 就这么简单!
});高级配置(可选)
可以自定义压缩选项和其他配置:
import { defineConfig } from 'astro/config';
import astroTips from 'astro-tips-pluss';
export default defineConfig({
integrations: [
astroTips({
// 开启 CSS 压缩 (默认: true)
minifyCSS: true,
// 开启 JS 压缩 (默认: true)
minifyJS: true,
// 可以添加自定义提示框类型
customTypes: {
myTip: {
icon: '🚀',
style: {
light: { background: '#f0f9ff' },
dark: { background: '#0c1825' },
border: '#3b82f6'
}
}
}
})
]
});配置选项详解
| 选项 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| minifyCSS | boolean | true | 是否启用 CSS 压缩 |
| minifyJS | boolean | true | 是否启用 JS 压缩 |
| customTypes | object | {} | 自定义提示框类型配置 |
🚀 使用方法
基础语法
在任何 Markdown 或 MDX 文件中使用以下简单语法:
:::类型名
你的内容(支持完整的 Markdown 语法)
:::实际示例
:::info
💡 **小贴士:** 这是一个信息提示框!
你可以在这里写任何内容:
- **加粗文字** 和 *斜体文字*
- [链接](https://astro.build)
- 甚至代码块:
```javascript
console.log('Hello, Astro Tips!');
```
:::渲染效果:

🎨 31 种内置样式
我们为你精心设计了 31 种提示框,满足各种使用场景:
📝 基础类型
tip💡 - 实用技巧和建议note📝 - 重要备注信息infoℹ️ - 一般信息说明warning⚠️ - 注意事项提醒
🚨 状态提醒
success✅ - 成功操作反馈error❌ - 错误信息提示danger⛔ - 危险警告caution🔻 - 谨慎提醒
💡 特殊用途
recommend👍 - 推荐内容important⭐ - 重要强调example🔍 - 示例演示question❓ - 问题提出answer✨ - 问题解答
🎯 其他类型
quote💭 - 引用内容mention💬 - 特别提及bug🐛 - Bug 相关提示
📋 项目管理
todo📋 - 待办事项feature✨ - 新功能介绍deprecated🚫 - 已废弃功能breaking💥 - 破坏性变更
🔒 技术专题
security🔒 - 安全提示performance⚡ - 性能优化accessibility♿ - 无障碍访问experimental🧪 - 实验性功能
🎉 版本相关
beta🎯 - Beta 版本new🎉 - 全新内容
🤖 AI & 自动化
ai🤖 - AI 相关内容bot🤖 - 机器人/自动化工具chat💬 - 聊天对话assistant👨💼 - 助手提示automation⚙️ - 自动化流程
使用示例
:::tip
💡 这是一个实用技巧提示框!
:::
:::warning
⚠️ 请注意这个重要的警告信息!
:::
:::success
✅ 操作成功完成!
:::
:::error
❌ 发生了一个错误,请检查你的代码。
:::
:::ai
🤖 AI 助手提示:这是一个 AI 相关的内容提示框。
:::
:::todo
📋 待办事项:记得完成这个重要的任务。
:::
:::feature
✨ 新功能:这个版本新增了令人兴奋的功能!
:::
:::security
🔒 安全提示:请确保你的密码足够复杂。
:::✨ 自动检测机制
- 🌞 用户偏好亮色模式 → 使用亮色提示框
- 🌙 用户偏好暗色模式 → 使用暗色提示框
- 💻 跟随系统设置 → 智能切换
🧩 更多使用场景
在博客中使用
提示框特别适合在博客文章中突出显示重要信息:
:::tip
💡 **作者提示:** 这篇文章需要基础的 HTML 和 CSS 知识。
:::
正文内容...
:::important
⭐ 请注意这个关键概念,它将在后续章节中反复出现。
:::在文档中使用
在技术文档中,提示框可以清晰地标注注意事项:
### 安装步骤
:::info
ℹ️ 安装前请确保 Node.js 版本 ≥ 16.0.0
:::
安装步骤说明...
:::warning
⚠️ 在生产环境中请不要使用默认配置,这可能会带来安全风险。
:::在教程中使用
教程中的提示框可以强调关键步骤:
:::success
✅ 恭喜!你已经完成了第一个 Astro 组件的创建。
:::
:::example
📖 **实例:** 以下是一个完整的组件示例
```js
// 示例代码:::
🔧 高级用法
嵌套内容支持
提示框内可以包含任何 Markdown 内容:
:::example
### 代码示例
这里演示如何使用 Astro:
```javascript
// astro.config.mjs
export default defineConfig({
integrations: [astroTips()]
});还可以包含:
- 列表项目
- 链接
引用内容 :::
### 主题自定义
通过 CSS 变量轻松自定义样式:
```css
/* 在你的全局样式文件中 */
:root {
--astro-tips-tip-bg-light: #f0f9ff;
--astro-tips-tip-bg-dark: #0c1825;
--astro-tips-tip-border: #3b82f6;
}TypeScript 支持
完整的 TypeScript 类型定义:
import type { AstroTipsOptions } from 'astro-tips';
const tipsConfig: AstroTipsOptions = {
minifyCSS: true,
minifyJS: true,
customTypes: {
// 完整的类型提示支持
}
};🛠️ 故障排除
常见问题
Q: 提示框没有显示?
A: 确保在 astro.config.mjs 中正确添加了集成。
Q: 样式不正确? A: 检查是否有 CSS 冲突,尝试清除浏览器缓存。
Q: 暗色模式不工作?
A: 确保你的站点支持 prefers-color-scheme 媒体查询。
调试模式
开启详细日志进行调试:
export default defineConfig({
integrations: [
astroTips({
debug: true // 开启调试模式
})
]
});📄 开源协议
本项目基于 MIT 协议 开源,欢迎自由使用和贡献!
觉得有用?别忘了给我们一个 ⭐ Star 哦!
