@mytechtoday/augment-extensions 0.7.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,376 +1,376 @@
1
- # Email Newsletter Example
2
-
3
- ## Overview
4
-
5
- Responsive HTML email newsletter template with mobile-first design, CAN-SPAM compliance, and best practices for deliverability and engagement.
6
-
7
- ---
8
-
9
- ## HTML Email Template
10
-
11
- ```html
12
- <!DOCTYPE html>
13
- <html lang="en">
14
- <head>
15
- <meta charset="UTF-8">
16
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
17
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
18
- <title>Monthly Newsletter - January 2026</title>
19
- <style>
20
- /* Reset styles */
21
- body, table, td, a { -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; }
22
- table, td { mso-table-lspace: 0pt; mso-table-rspace: 0pt; }
23
- img { -ms-interpolation-mode: bicubic; border: 0; height: auto; line-height: 100%; outline: none; text-decoration: none; }
24
-
25
- /* Base styles */
26
- body {
27
- margin: 0;
28
- padding: 0;
29
- width: 100% !important;
30
- font-family: Arial, Helvetica, sans-serif;
31
- background-color: #f4f4f4;
32
- }
33
-
34
- /* Container */
35
- .email-container {
36
- max-width: 600px;
37
- margin: 0 auto;
38
- background-color: #ffffff;
39
- }
40
-
41
- /* Header */
42
- .header {
43
- background-color: #0066cc;
44
- padding: 20px;
45
- text-align: center;
46
- }
47
-
48
- .header img {
49
- max-width: 200px;
50
- height: auto;
51
- }
52
-
53
- /* Content */
54
- .content {
55
- padding: 30px 20px;
56
- }
57
-
58
- .content h1 {
59
- color: #333333;
60
- font-size: 24px;
61
- margin: 0 0 20px 0;
62
- line-height: 1.3;
63
- }
64
-
65
- .content h2 {
66
- color: #0066cc;
67
- font-size: 20px;
68
- margin: 30px 0 15px 0;
69
- }
70
-
71
- .content p {
72
- color: #666666;
73
- font-size: 16px;
74
- line-height: 1.6;
75
- margin: 0 0 15px 0;
76
- }
77
-
78
- /* Button */
79
- .button {
80
- display: inline-block;
81
- padding: 14px 30px;
82
- background-color: #0066cc;
83
- color: #ffffff !important;
84
- text-decoration: none;
85
- border-radius: 5px;
86
- font-weight: bold;
87
- margin: 10px 0;
88
- }
89
-
90
- .button:hover {
91
- background-color: #0052a3;
92
- }
93
-
94
- /* Article card */
95
- .article-card {
96
- border: 1px solid #e0e0e0;
97
- border-radius: 8px;
98
- padding: 20px;
99
- margin: 20px 0;
100
- }
101
-
102
- .article-card img {
103
- max-width: 100%;
104
- height: auto;
105
- border-radius: 5px;
106
- margin-bottom: 15px;
107
- }
108
-
109
- /* Footer */
110
- .footer {
111
- background-color: #333333;
112
- color: #ffffff;
113
- padding: 30px 20px;
114
- text-align: center;
115
- font-size: 14px;
116
- }
117
-
118
- .footer a {
119
- color: #ffffff;
120
- text-decoration: underline;
121
- }
122
-
123
- .social-links {
124
- margin: 20px 0;
125
- }
126
-
127
- .social-links a {
128
- display: inline-block;
129
- margin: 0 10px;
130
- }
131
-
132
- /* Mobile responsive */
133
- @media only screen and (max-width: 600px) {
134
- .content h1 { font-size: 20px !important; }
135
- .content h2 { font-size: 18px !important; }
136
- .content p { font-size: 14px !important; }
137
- .button { display: block !important; width: 100% !important; }
138
- }
139
- </style>
140
- </head>
141
- <body>
142
- <!-- Preheader text (hidden but shows in inbox preview) -->
143
- <div style="display: none; max-height: 0; overflow: hidden;">
144
- Your monthly dose of insights, tips, and updates from [Company Name]
145
- </div>
146
-
147
- <!-- Email container -->
148
- <table role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%">
149
- <tr>
150
- <td style="padding: 20px 0;">
151
- <table role="presentation" cellspacing="0" cellpadding="0" border="0" class="email-container">
152
-
153
- <!-- Header -->
154
- <tr>
155
- <td class="header">
156
- <img src="https://cdn.example.com/logo-white.png" alt="Company Logo" width="200">
157
- </td>
158
- </tr>
159
-
160
- <!-- Main content -->
161
- <tr>
162
- <td class="content">
163
- <h1>Welcome to Our January Newsletter! 🎉</h1>
164
-
165
- <p>Hi {{first_name}},</p>
166
-
167
- <p>Happy New Year! We're excited to share what's new this month, including product updates, helpful resources, and exclusive offers just for you.</p>
168
-
169
- <!-- Featured article -->
170
- <div class="article-card">
171
- <img src="https://cdn.example.com/featured-article.jpg" alt="Featured Article">
172
- <h2>10 Strategies to Boost Your Productivity in 2026</h2>
173
- <p>Discover proven techniques to maximize your efficiency and achieve your goals this year.</p>
174
- <a href="https://example.com/article/productivity-2026" class="button">Read More</a>
175
- </div>
176
-
177
- <!-- Product update -->
178
- <h2>🚀 New Feature: AI-Powered Analytics</h2>
179
- <p>We've just launched our most requested feature! Get instant insights from your data with our new AI-powered analytics dashboard.</p>
180
- <a href="https://example.com/features/ai-analytics" class="button">Try It Now</a>
181
-
182
- <!-- Blog posts -->
183
- <h2>📚 Latest from Our Blog</h2>
184
-
185
- <p><strong><a href="https://example.com/blog/post-1">How to Optimize Your Workflow</a></strong><br>
186
- Learn the secrets to streamlining your daily tasks.</p>
187
-
188
- <p><strong><a href="https://example.com/blog/post-2">Customer Success Story: Acme Corp</a></strong><br>
189
- See how Acme Corp increased revenue by 150% using our platform.</p>
190
-
191
- <p><strong><a href="https://example.com/blog/post-3">5 Common Mistakes to Avoid</a></strong><br>
192
- Don't fall into these traps - here's what to watch out for.</p>
193
-
194
- <!-- Special offer -->
195
- <div style="background-color: #fff3cd; border-left: 4px solid #ffc107; padding: 15px; margin: 20px 0;">
196
- <h2 style="margin-top: 0; color: #856404;">🎁 Exclusive Offer for Subscribers</h2>
197
- <p style="color: #856404; margin-bottom: 10px;">Get 20% off any annual plan this month! Use code <strong>JAN2026</strong> at checkout.</p>
198
- <a href="https://example.com/pricing?code=JAN2026" class="button" style="background-color: #ffc107; color: #000000 !important;">Claim Your Discount</a>
199
- </div>
200
-
201
- <!-- Upcoming events -->
202
- <h2>📅 Upcoming Events</h2>
203
- <p><strong>Webinar: Mastering Data Analytics</strong><br>
204
- January 25, 2026 at 2:00 PM EST<br>
205
- <a href="https://example.com/webinar/data-analytics">Register Now</a></p>
206
-
207
- <p><strong>Product Demo: New Features Walkthrough</strong><br>
208
- February 1, 2026 at 11:00 AM EST<br>
209
- <a href="https://example.com/demo/new-features">Save Your Spot</a></p>
210
-
211
- <!-- Closing -->
212
- <p style="margin-top: 30px;">Thanks for being part of our community! If you have any questions or feedback, just reply to this email.</p>
213
-
214
- <p>Best regards,<br>
215
- <strong>The [Company Name] Team</strong></p>
216
- </td>
217
- </tr>
218
-
219
- <!-- Footer -->
220
- <tr>
221
- <td class="footer">
222
- <!-- Social links -->
223
- <div class="social-links">
224
- <a href="https://twitter.com/company"><img src="https://cdn.example.com/icon-twitter.png" alt="Twitter" width="32"></a>
225
- <a href="https://linkedin.com/company/company"><img src="https://cdn.example.com/icon-linkedin.png" alt="LinkedIn" width="32"></a>
226
- <a href="https://facebook.com/company"><img src="https://cdn.example.com/icon-facebook.png" alt="Facebook" width="32"></a>
227
- </div>
228
-
229
- <!-- Company info -->
230
- <p style="margin: 10px 0;">
231
- <strong>[Company Name]</strong><br>
232
- 123 Main Street, Suite 100<br>
233
- San Francisco, CA 94105
234
- </p>
235
-
236
- <!-- CAN-SPAM compliance -->
237
- <p style="margin: 20px 0 10px 0; font-size: 12px; color: #999999;">
238
- You're receiving this email because you subscribed to our newsletter.<br>
239
- <a href="{{unsubscribe_url}}" style="color: #999999;">Unsubscribe</a> |
240
- <a href="{{preferences_url}}" style="color: #999999;">Update Preferences</a> |
241
- <a href="https://example.com/privacy" style="color: #999999;">Privacy Policy</a>
242
- </p>
243
-
244
- <p style="font-size: 12px; color: #999999;">
245
- © 2026 [Company Name]. All rights reserved.
246
- </p>
247
- </td>
248
- </tr>
249
-
250
- </table>
251
- </td>
252
- </tr>
253
- </table>
254
- </body>
255
- </html>
256
- ```
257
-
258
- ---
259
-
260
- ## CAN-SPAM Compliance Checklist
261
-
262
- ### Required Elements
263
-
264
- ✅ **Accurate "From" Information**
265
- - Use real company name and email address
266
- - Don't use misleading sender information
267
-
268
- ✅ **Clear Subject Line**
269
- - Subject must accurately reflect email content
270
- - No deceptive subject lines
271
-
272
- ✅ **Identify as Advertisement (if applicable)**
273
- - Clearly disclose if email is promotional
274
-
275
- ✅ **Physical Address**
276
- - Include valid physical postal address
277
- - Can be street address or P.O. box
278
-
279
- ✅ **Unsubscribe Mechanism**
280
- - Provide clear, conspicuous unsubscribe link
281
- - Process unsubscribe requests within 10 business days
282
- - Don't charge fee or require login to unsubscribe
283
-
284
- ✅ **Honor Opt-Outs Promptly**
285
- - Stop sending emails within 10 business days
286
- - Don't sell/transfer email addresses of unsubscribers
287
-
288
- ---
289
-
290
- ## Email Best Practices
291
-
292
- ### Subject Lines
293
-
294
- **Good Examples:**
295
- - "Your January Newsletter: New Features + Exclusive Offer 🎁"
296
- - "[First Name], here's your personalized productivity guide"
297
- - "Last chance: 20% off ends tonight"
298
-
299
- **Bad Examples:**
300
- - "RE: Important" (misleading)
301
- - "FREE MONEY!!!" (spammy)
302
- - "You won't believe this..." (clickbait)
303
-
304
- ### Preheader Text
305
-
306
- The preheader appears after the subject line in inbox previews. Use it wisely:
307
-
308
- ```html
309
- <!-- Good preheader -->
310
- <div style="display: none; max-height: 0; overflow: hidden;">
311
- New features, exclusive offers, and productivity tips inside
312
- </div>
313
- ```
314
-
315
- ### Personalization
316
-
317
- Use merge tags for personalization:
318
- - `{{first_name}}` - First name
319
- - `{{company}}` - Company name
320
- - `{{last_purchase}}` - Last purchase date
321
- - `{{custom_field}}` - Any custom field
322
-
323
- ### Mobile Optimization
324
-
325
- - Use single-column layout
326
- - Minimum 14px font size
327
- - Large, tappable buttons (44x44px minimum)
328
- - Optimize images for mobile (compress, use responsive images)
329
- - Test on multiple devices and email clients
330
-
331
- ---
332
-
333
- ## Testing Checklist
334
-
335
- ### Before Sending
336
-
337
- - [ ] Test on major email clients (Gmail, Outlook, Apple Mail)
338
- - [ ] Test on mobile devices (iOS, Android)
339
- - [ ] Check all links work correctly
340
- - [ ] Verify personalization tokens populate correctly
341
- - [ ] Test unsubscribe link
342
- - [ ] Check images load (and alt text displays if blocked)
343
- - [ ] Proofread all copy
344
- - [ ] Verify CAN-SPAM compliance
345
- - [ ] Run spam score test (Mail Tester, Litmus)
346
- - [ ] Send test to team for review
347
-
348
- ---
349
-
350
- ## Performance Metrics
351
-
352
- ### Key Metrics to Track
353
-
354
- - **Open Rate:** 15-25% (average), 25%+ (good)
355
- - **Click-Through Rate:** 2-5% (average), 5%+ (good)
356
- - **Conversion Rate:** 1-3% (average), 3%+ (good)
357
- - **Unsubscribe Rate:** <0.5% (good), <0.2% (excellent)
358
- - **Bounce Rate:** <2% (good), <1% (excellent)
359
- - **Spam Complaint Rate:** <0.1% (critical threshold)
360
-
361
- ### A/B Testing Ideas
362
-
363
- 1. **Subject Lines:** With/without emoji, personalization, urgency
364
- 2. **Send Time:** Morning vs. afternoon, weekday vs. weekend
365
- 3. **Content:** Long vs. short, single topic vs. digest
366
- 4. **CTA:** Button text, color, placement
367
- 5. **Images:** With/without hero image, product photos
368
-
369
- ---
370
-
371
- ## Related Resources
372
-
373
- - **conversion-optimization.md** - CTA and email optimization
374
- - **content-marketing.md** - Email content strategy
375
- - **universal-marketing.md** - Email metrics and KPIs
376
-
1
+ # Email Newsletter Example
2
+
3
+ ## Overview
4
+
5
+ Responsive HTML email newsletter template with mobile-first design, CAN-SPAM compliance, and best practices for deliverability and engagement.
6
+
7
+ ---
8
+
9
+ ## HTML Email Template
10
+
11
+ ```html
12
+ <!DOCTYPE html>
13
+ <html lang="en">
14
+ <head>
15
+ <meta charset="UTF-8">
16
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
17
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
18
+ <title>Monthly Newsletter - January 2026</title>
19
+ <style>
20
+ /* Reset styles */
21
+ body, table, td, a { -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; }
22
+ table, td { mso-table-lspace: 0pt; mso-table-rspace: 0pt; }
23
+ img { -ms-interpolation-mode: bicubic; border: 0; height: auto; line-height: 100%; outline: none; text-decoration: none; }
24
+
25
+ /* Base styles */
26
+ body {
27
+ margin: 0;
28
+ padding: 0;
29
+ width: 100% !important;
30
+ font-family: Arial, Helvetica, sans-serif;
31
+ background-color: #f4f4f4;
32
+ }
33
+
34
+ /* Container */
35
+ .email-container {
36
+ max-width: 600px;
37
+ margin: 0 auto;
38
+ background-color: #ffffff;
39
+ }
40
+
41
+ /* Header */
42
+ .header {
43
+ background-color: #0066cc;
44
+ padding: 20px;
45
+ text-align: center;
46
+ }
47
+
48
+ .header img {
49
+ max-width: 200px;
50
+ height: auto;
51
+ }
52
+
53
+ /* Content */
54
+ .content {
55
+ padding: 30px 20px;
56
+ }
57
+
58
+ .content h1 {
59
+ color: #333333;
60
+ font-size: 24px;
61
+ margin: 0 0 20px 0;
62
+ line-height: 1.3;
63
+ }
64
+
65
+ .content h2 {
66
+ color: #0066cc;
67
+ font-size: 20px;
68
+ margin: 30px 0 15px 0;
69
+ }
70
+
71
+ .content p {
72
+ color: #666666;
73
+ font-size: 16px;
74
+ line-height: 1.6;
75
+ margin: 0 0 15px 0;
76
+ }
77
+
78
+ /* Button */
79
+ .button {
80
+ display: inline-block;
81
+ padding: 14px 30px;
82
+ background-color: #0066cc;
83
+ color: #ffffff !important;
84
+ text-decoration: none;
85
+ border-radius: 5px;
86
+ font-weight: bold;
87
+ margin: 10px 0;
88
+ }
89
+
90
+ .button:hover {
91
+ background-color: #0052a3;
92
+ }
93
+
94
+ /* Article card */
95
+ .article-card {
96
+ border: 1px solid #e0e0e0;
97
+ border-radius: 8px;
98
+ padding: 20px;
99
+ margin: 20px 0;
100
+ }
101
+
102
+ .article-card img {
103
+ max-width: 100%;
104
+ height: auto;
105
+ border-radius: 5px;
106
+ margin-bottom: 15px;
107
+ }
108
+
109
+ /* Footer */
110
+ .footer {
111
+ background-color: #333333;
112
+ color: #ffffff;
113
+ padding: 30px 20px;
114
+ text-align: center;
115
+ font-size: 14px;
116
+ }
117
+
118
+ .footer a {
119
+ color: #ffffff;
120
+ text-decoration: underline;
121
+ }
122
+
123
+ .social-links {
124
+ margin: 20px 0;
125
+ }
126
+
127
+ .social-links a {
128
+ display: inline-block;
129
+ margin: 0 10px;
130
+ }
131
+
132
+ /* Mobile responsive */
133
+ @media only screen and (max-width: 600px) {
134
+ .content h1 { font-size: 20px !important; }
135
+ .content h2 { font-size: 18px !important; }
136
+ .content p { font-size: 14px !important; }
137
+ .button { display: block !important; width: 100% !important; }
138
+ }
139
+ </style>
140
+ </head>
141
+ <body>
142
+ <!-- Preheader text (hidden but shows in inbox preview) -->
143
+ <div style="display: none; max-height: 0; overflow: hidden;">
144
+ Your monthly dose of insights, tips, and updates from [Company Name]
145
+ </div>
146
+
147
+ <!-- Email container -->
148
+ <table role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%">
149
+ <tr>
150
+ <td style="padding: 20px 0;">
151
+ <table role="presentation" cellspacing="0" cellpadding="0" border="0" class="email-container">
152
+
153
+ <!-- Header -->
154
+ <tr>
155
+ <td class="header">
156
+ <img src="https://cdn.example.com/logo-white.png" alt="Company Logo" width="200">
157
+ </td>
158
+ </tr>
159
+
160
+ <!-- Main content -->
161
+ <tr>
162
+ <td class="content">
163
+ <h1>Welcome to Our January Newsletter! 🎉</h1>
164
+
165
+ <p>Hi {{first_name}},</p>
166
+
167
+ <p>Happy New Year! We're excited to share what's new this month, including product updates, helpful resources, and exclusive offers just for you.</p>
168
+
169
+ <!-- Featured article -->
170
+ <div class="article-card">
171
+ <img src="https://cdn.example.com/featured-article.jpg" alt="Featured Article">
172
+ <h2>10 Strategies to Boost Your Productivity in 2026</h2>
173
+ <p>Discover proven techniques to maximize your efficiency and achieve your goals this year.</p>
174
+ <a href="https://example.com/article/productivity-2026" class="button">Read More</a>
175
+ </div>
176
+
177
+ <!-- Product update -->
178
+ <h2>🚀 New Feature: AI-Powered Analytics</h2>
179
+ <p>We've just launched our most requested feature! Get instant insights from your data with our new AI-powered analytics dashboard.</p>
180
+ <a href="https://example.com/features/ai-analytics" class="button">Try It Now</a>
181
+
182
+ <!-- Blog posts -->
183
+ <h2>📚 Latest from Our Blog</h2>
184
+
185
+ <p><strong><a href="https://example.com/blog/post-1">How to Optimize Your Workflow</a></strong><br>
186
+ Learn the secrets to streamlining your daily tasks.</p>
187
+
188
+ <p><strong><a href="https://example.com/blog/post-2">Customer Success Story: Acme Corp</a></strong><br>
189
+ See how Acme Corp increased revenue by 150% using our platform.</p>
190
+
191
+ <p><strong><a href="https://example.com/blog/post-3">5 Common Mistakes to Avoid</a></strong><br>
192
+ Don't fall into these traps - here's what to watch out for.</p>
193
+
194
+ <!-- Special offer -->
195
+ <div style="background-color: #fff3cd; border-left: 4px solid #ffc107; padding: 15px; margin: 20px 0;">
196
+ <h2 style="margin-top: 0; color: #856404;">🎁 Exclusive Offer for Subscribers</h2>
197
+ <p style="color: #856404; margin-bottom: 10px;">Get 20% off any annual plan this month! Use code <strong>JAN2026</strong> at checkout.</p>
198
+ <a href="https://example.com/pricing?code=JAN2026" class="button" style="background-color: #ffc107; color: #000000 !important;">Claim Your Discount</a>
199
+ </div>
200
+
201
+ <!-- Upcoming events -->
202
+ <h2>📅 Upcoming Events</h2>
203
+ <p><strong>Webinar: Mastering Data Analytics</strong><br>
204
+ January 25, 2026 at 2:00 PM EST<br>
205
+ <a href="https://example.com/webinar/data-analytics">Register Now</a></p>
206
+
207
+ <p><strong>Product Demo: New Features Walkthrough</strong><br>
208
+ February 1, 2026 at 11:00 AM EST<br>
209
+ <a href="https://example.com/demo/new-features">Save Your Spot</a></p>
210
+
211
+ <!-- Closing -->
212
+ <p style="margin-top: 30px;">Thanks for being part of our community! If you have any questions or feedback, just reply to this email.</p>
213
+
214
+ <p>Best regards,<br>
215
+ <strong>The [Company Name] Team</strong></p>
216
+ </td>
217
+ </tr>
218
+
219
+ <!-- Footer -->
220
+ <tr>
221
+ <td class="footer">
222
+ <!-- Social links -->
223
+ <div class="social-links">
224
+ <a href="https://twitter.com/company"><img src="https://cdn.example.com/icon-twitter.png" alt="Twitter" width="32"></a>
225
+ <a href="https://linkedin.com/company/company"><img src="https://cdn.example.com/icon-linkedin.png" alt="LinkedIn" width="32"></a>
226
+ <a href="https://facebook.com/company"><img src="https://cdn.example.com/icon-facebook.png" alt="Facebook" width="32"></a>
227
+ </div>
228
+
229
+ <!-- Company info -->
230
+ <p style="margin: 10px 0;">
231
+ <strong>[Company Name]</strong><br>
232
+ 123 Main Street, Suite 100<br>
233
+ San Francisco, CA 94105
234
+ </p>
235
+
236
+ <!-- CAN-SPAM compliance -->
237
+ <p style="margin: 20px 0 10px 0; font-size: 12px; color: #999999;">
238
+ You're receiving this email because you subscribed to our newsletter.<br>
239
+ <a href="{{unsubscribe_url}}" style="color: #999999;">Unsubscribe</a> |
240
+ <a href="{{preferences_url}}" style="color: #999999;">Update Preferences</a> |
241
+ <a href="https://example.com/privacy" style="color: #999999;">Privacy Policy</a>
242
+ </p>
243
+
244
+ <p style="font-size: 12px; color: #999999;">
245
+ © 2026 [Company Name]. All rights reserved.
246
+ </p>
247
+ </td>
248
+ </tr>
249
+
250
+ </table>
251
+ </td>
252
+ </tr>
253
+ </table>
254
+ </body>
255
+ </html>
256
+ ```
257
+
258
+ ---
259
+
260
+ ## CAN-SPAM Compliance Checklist
261
+
262
+ ### Required Elements
263
+
264
+ ✅ **Accurate "From" Information**
265
+ - Use real company name and email address
266
+ - Don't use misleading sender information
267
+
268
+ ✅ **Clear Subject Line**
269
+ - Subject must accurately reflect email content
270
+ - No deceptive subject lines
271
+
272
+ ✅ **Identify as Advertisement (if applicable)**
273
+ - Clearly disclose if email is promotional
274
+
275
+ ✅ **Physical Address**
276
+ - Include valid physical postal address
277
+ - Can be street address or P.O. box
278
+
279
+ ✅ **Unsubscribe Mechanism**
280
+ - Provide clear, conspicuous unsubscribe link
281
+ - Process unsubscribe requests within 10 business days
282
+ - Don't charge fee or require login to unsubscribe
283
+
284
+ ✅ **Honor Opt-Outs Promptly**
285
+ - Stop sending emails within 10 business days
286
+ - Don't sell/transfer email addresses of unsubscribers
287
+
288
+ ---
289
+
290
+ ## Email Best Practices
291
+
292
+ ### Subject Lines
293
+
294
+ **Good Examples:**
295
+ - "Your January Newsletter: New Features + Exclusive Offer 🎁"
296
+ - "[First Name], here's your personalized productivity guide"
297
+ - "Last chance: 20% off ends tonight"
298
+
299
+ **Bad Examples:**
300
+ - "RE: Important" (misleading)
301
+ - "FREE MONEY!!!" (spammy)
302
+ - "You won't believe this..." (clickbait)
303
+
304
+ ### Preheader Text
305
+
306
+ The preheader appears after the subject line in inbox previews. Use it wisely:
307
+
308
+ ```html
309
+ <!-- Good preheader -->
310
+ <div style="display: none; max-height: 0; overflow: hidden;">
311
+ New features, exclusive offers, and productivity tips inside
312
+ </div>
313
+ ```
314
+
315
+ ### Personalization
316
+
317
+ Use merge tags for personalization:
318
+ - `{{first_name}}` - First name
319
+ - `{{company}}` - Company name
320
+ - `{{last_purchase}}` - Last purchase date
321
+ - `{{custom_field}}` - Any custom field
322
+
323
+ ### Mobile Optimization
324
+
325
+ - Use single-column layout
326
+ - Minimum 14px font size
327
+ - Large, tappable buttons (44x44px minimum)
328
+ - Optimize images for mobile (compress, use responsive images)
329
+ - Test on multiple devices and email clients
330
+
331
+ ---
332
+
333
+ ## Testing Checklist
334
+
335
+ ### Before Sending
336
+
337
+ - [ ] Test on major email clients (Gmail, Outlook, Apple Mail)
338
+ - [ ] Test on mobile devices (iOS, Android)
339
+ - [ ] Check all links work correctly
340
+ - [ ] Verify personalization tokens populate correctly
341
+ - [ ] Test unsubscribe link
342
+ - [ ] Check images load (and alt text displays if blocked)
343
+ - [ ] Proofread all copy
344
+ - [ ] Verify CAN-SPAM compliance
345
+ - [ ] Run spam score test (Mail Tester, Litmus)
346
+ - [ ] Send test to team for review
347
+
348
+ ---
349
+
350
+ ## Performance Metrics
351
+
352
+ ### Key Metrics to Track
353
+
354
+ - **Open Rate:** 15-25% (average), 25%+ (good)
355
+ - **Click-Through Rate:** 2-5% (average), 5%+ (good)
356
+ - **Conversion Rate:** 1-3% (average), 3%+ (good)
357
+ - **Unsubscribe Rate:** <0.5% (good), <0.2% (excellent)
358
+ - **Bounce Rate:** <2% (good), <1% (excellent)
359
+ - **Spam Complaint Rate:** <0.1% (critical threshold)
360
+
361
+ ### A/B Testing Ideas
362
+
363
+ 1. **Subject Lines:** With/without emoji, personalization, urgency
364
+ 2. **Send Time:** Morning vs. afternoon, weekday vs. weekend
365
+ 3. **Content:** Long vs. short, single topic vs. digest
366
+ 4. **CTA:** Button text, color, placement
367
+ 5. **Images:** With/without hero image, product photos
368
+
369
+ ---
370
+
371
+ ## Related Resources
372
+
373
+ - **conversion-optimization.md** - CTA and email optimization
374
+ - **content-marketing.md** - Email content strategy
375
+ - **universal-marketing.md** - Email metrics and KPIs
376
+