_pkgdown.yml

url: https://rstudio.github.io/blastula

template:
  package: quillt
  opengraph:
    image:
      src: man/figures/logo.png
      alt: "blastula package"
    twitter:
      creator: "@rstudio"
      card: summary

development:
  version_tooltip: "Development version"

reference:
  - title: Composing an Email Message
    desc: >
      An email message can be easily created with the `compose_email()`
      function. Want to attach files to the message? That's a cinch with
      `add_attachment()`. We can experiment with a example email message using
      `prepare_test_message()`.
    contents:
    - compose_email
    - add_attachment
    - prepare_test_message
    - blastula_template

  - title: Add Inline Components
    desc: >
      Several types of useful HTML fragments generated and incorporated into the
      email message content. We can create and use CTA buttons, links to images,
      and more!
    contents:
    - add_image
    - add_imgur_image
    - add_cta_button
    - add_ggplot
    - add_readable_time
    - md
    - starts_with("%")

  - title: HTML Blocks
    desc: >
      We can use HTML blocks to compose our email message. These functions are
      placed inside of an unnamed list and the order determines the ordering of
      the blocks. With these responsive, higher-level components, we can create
      sophisticated email messages with minimal effort.
    contents:
    - blocks
    - block_title
    - block_text
    - block_spacer
    - block_articles
    - block_social_links
    - article
    - social_link

  - title: Email Sending through SMTP
    desc: >
      Once the email looks good enough to send, we can send it through an SMTP
      server, with the MailGun service, or simply extract the HTML message body
      and go elsewhere. There is also the convenient option to create and store
      SMTP credentials with either the `create_smtp_creds_file()` or the
      `create_smtp_creds_key()` function.
    contents:
    - smtp_send
    - send_by_mailgun
    - get_html_str
    - create_smtp_creds_file
    - create_smtp_creds_key
    - credential_helpers
    - view_credential_keys
    - delete_credential_key
    - delete_all_credential_keys

  - title: Email Sending through Posit Connect
    desc: >
      Using the Posit Connect service, it's possible to publish R Markdown
      documents and provide a scheduled email based on the report. Example
      .Rmd documents can be generated by using the `prepare_rsc_example_files()`
      function. These files constitute a working example for a publishing
      workflow that uses the `render_connect_email()` and
      `attach_connect_email()` functions.
    contents:
    - render_email
    - attach_connect_email
    - blastula_email
    - suppress_scheduled_email
    - prepare_rsc_example_files

navbar:
  title: ~
  type: default
  structure:
    left:  [intro, examples, articles]
    right: [reference, news, github]
  components:
    home: ~
    intro:
      text: Get started
      href: articles/blastula.html
    examples:
      text: Examples
      menu:
        - text: "Custom Emails with R Markdown and Blastula"
          href: https://solutions.rstudio.com/r/blastula/
        - text: "Customized Conditional Emails with Posit Connect"
          href: https://solutions.rstudio.com/r/blastula/conditional-example/
        - text: "Scheduling Data Science Tasks"
          href: https://solutions.rstudio.com/data-science-admin/scheduling/
    articles:
      text: Articles
      menu:
        - text: "Sending Email Using SMTP"
          href: articles/sending_using_smtp.html
    reference:
      text: Reference
      href: reference/index.html
    news:
      text: News
      menu:
        - text: "Changelog"
          href: news/index.html
        - text: "------------------"
        - text: "Blog posts"
        - text: "Version 0.3"
          href: https://blog.rstudio.com/2019/12/05/emails-from-r-blastula-0-3/
    github:
      icon: fab fa-github fa-lg
      href: https://github.com/rstudio/blastula