{"_path":"/providers/buttondown","_draft":false,"_partial":false,"_empty":false,"title":"Buttondown","description":"Learn more about the Buttondown provider integration for newsletter module.","excerpt":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Buttondown is a small, elegant tool for producing newsletters. The minimalist interface makes it easy for you to write great emails; the automation acts like the editorial assistant you wish you had, by checking for typos, broken links, or malformed images; the portable subscription widget makes it really easy to grow your audience from wherever you host your site."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can learn more about Buttondown "},{"type":"element","tag":"a","props":{"href":"https://buttondown.email/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usage"},"children":[{"type":"text","value":"Usage"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order to have Buttondown as your newsletter provider set the provider option in the configuration options of the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-newsletter"}]},{"type":"text","value":" module to 'buttondown' like following:"}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: [\n    'nuxt-newsletter'\n  ],\n  newsletter: {\n    buttondown: {\n      apiKey: process.env.BUTTONDOWN_API_KEY,\n      component: true // optional\n    }\n  }\n})\n","filename":"nuxt.config.js|ts","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"export default defineNuxtConfig({\n  modules: [\n    'nuxt-newsletter'\n  ],\n  newsletter: {\n    buttondown: {\n      apiKey: process.env.BUTTONDOWN_API_KEY,\n      component: true // optional\n    }\n  }\n})\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can then use the built in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"NewsletterForm.vue"}]},{"type":"text","value":" component or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useNewsletterSubscribe"}]},{"type":"text","value":" composable to handle adding new email to subscribers list."}]}]},"body":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Buttondown is a small, elegant tool for producing newsletters. The minimalist interface makes it easy for you to write great emails; the automation acts like the editorial assistant you wish you had, by checking for typos, broken links, or malformed images; the portable subscription widget makes it really easy to grow your audience from wherever you host your site."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can learn more about Buttondown "},{"type":"element","tag":"a","props":{"href":"https://buttondown.email/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"here"}]}]},{"type":"element","tag":"h2","props":{"id":"usage"},"children":[{"type":"text","value":"Usage"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"In order to have Buttondown as your newsletter provider set the provider option in the configuration options of the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"nuxt-newsletter"}]},{"type":"text","value":" module to 'buttondown' like following:"}]},{"type":"element","tag":"code","props":{"code":"export default defineNuxtConfig({\n  modules: [\n    'nuxt-newsletter'\n  ],\n  newsletter: {\n    buttondown: {\n      apiKey: process.env.BUTTONDOWN_API_KEY,\n      component: true // optional\n    }\n  }\n})\n","filename":"nuxt.config.js|ts","language":"ts"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-0e5c4f"},"children":[{"type":"text","value":"export"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0e5c4f"},"children":[{"type":"text","value":"default"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d95023"},"children":[{"type":"text","value":"defineNuxtConfig"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"({"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-175bbb"},"children":[{"type":"text","value":"modules"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":": ["}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-50af1b"},"children":[{"type":"text","value":"'nuxt-newsletter'"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"  ],"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-175bbb"},"children":[{"type":"text","value":"newsletter"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"    "}]},{"type":"element","tag":"span","props":{"class":"ct-175bbb"},"children":[{"type":"text","value":"buttondown"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":": {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"      "}]},{"type":"element","tag":"span","props":{"class":"ct-175bbb"},"children":[{"type":"text","value":"apiKey"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-5cc016"},"children":[{"type":"text","value":"process"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-5cc016"},"children":[{"type":"text","value":"env"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-175bbb"},"children":[{"type":"text","value":"BUTTONDOWN_API_KEY"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":","}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"      "}]},{"type":"element","tag":"span","props":{"class":"ct-175bbb"},"children":[{"type":"text","value":"component"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-5ac472"},"children":[{"type":"text","value":"true"}]},{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-0ad0e6"},"children":[{"type":"text","value":"// optional"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"    }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"  }"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-69b075"},"children":[{"type":"text","value":"})"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"You can then use the built in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"NewsletterForm.vue"}]},{"type":"text","value":" component or "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useNewsletterSubscribe"}]},{"type":"text","value":" composable to handle adding new email to subscribers list."}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-0ad0e6{color:#7F848E}.ct-5ac472{color:#D19A66}.ct-5cc016{color:#E5C07B}.ct-50af1b{color:#98C379}.ct-175bbb{color:#E06C75}.ct-d95023{color:#61AFEF}.ct-69b075{color:#ABB2BF}.ct-0e5c4f{color:#C678DD}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"usage","depth":2,"text":"Usage"}]}},"_type":"markdown","_id":"content:3.providers:3.buttondown.md","_source":"content","_file":"3.providers/3.buttondown.md","_extension":"md"}