Skip to content

Commit fd245b9

Browse files
committed
doc descriptions
1 parent feb32ef commit fd245b9

10 files changed

Lines changed: 10 additions & 0 deletions

docs/bindings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Language Bindings"
4+
description: "Official Inky bindings for Node.js, PHP, Python, Ruby, and Go. Transform Inky markup to email HTML in any language."
45
nav_group: "Guides"
56
nav_order: 2
67
---

docs/compatibility.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Email Client Compatibility"
4+
description: "Email client support matrix for Inky output. Covers desktop, mobile, and web clients with rendering engine details."
45
nav_group: "Guides"
56
nav_order: 4
67
---

docs/components.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Component Reference"
4+
description: "Reference for all 27 Inky components — container, row, column, button, callout, card, hero, social, and more."
45
nav_group: "Features"
56
nav_order: 1
67
---

docs/data-merging.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Data Merging"
4+
description: "Merge JSON data into Inky templates using MiniJinja. Preview emails with real data or generate final output with variables."
45
nav_group: "Features"
56
nav_order: 3
67
---

docs/email-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Email Development Guide"
4+
description: "Practical guide to building HTML emails that render correctly across every major client. Tips for images, fonts, and testing."
45
nav_group: "Guides"
56
nav_order: 1
67
---

docs/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Installation & Usage"
4+
description: "Install Inky via Homebrew, npm, or Cargo. Scaffold an email project, build templates, and preview with live reload."
45
nav_group: "Getting Started"
56
nav_order: 1
67
---

docs/hybrid-output.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Hybrid Output Mode"
4+
description: "Generate div-based layouts for modern email clients with automatic Outlook table fallbacks via MSO conditional comments."
45
nav_group: "Features"
56
nav_order: 4
67
---

docs/migration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Migration Guide: v1 to v2"
4+
description: "Migrate from Foundation for Emails (Inky v1) to Inky v2. Covers syntax changes, removed features, and upgrade steps."
45
nav_group: "Guides"
56
nav_order: 3
67
---

docs/styles.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Style Reference"
4+
description: "Inky's built-in SCSS framework for responsive email styles. Override variables for colors, typography, spacing, and dark mode."
45
nav_group: "Features"
56
nav_order: 2
67
---

docs/troubleshooting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
raw: true
33
title: "Troubleshooting"
4+
description: "Solutions for common Inky issues — build errors, rendering problems, Outlook quirks, and CSS inlining troubleshooting."
45
nav_group: "Guides"
56
nav_order: 5
67
---

0 commit comments

Comments
 (0)