From 5a74a17d9b1f8f1c885501dac50dd7888d16be26 Mon Sep 17 00:00:00 2001 From: cromelex <96779452+cromelex@users.noreply.github.com> Date: Thu, 15 May 2025 23:51:22 +0100 Subject: [PATCH] feat:ReplyByEmail button Updated documentation for the component --- docs/features/replybyemail button.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/features/replybyemail button.md b/docs/features/replybyemail button.md index ead09cf67..77092a32f 100644 --- a/docs/features/replybyemail button.md +++ b/docs/features/replybyemail button.md @@ -4,9 +4,9 @@ tags: - component --- -The Reply By Email Button is a feature that allows users to display a button under their notes, allowing visitors to send them an email to an obfuscated email address. +The Reply By Email Button is a feature that allows users to display a button under their notes, allowing visitors to comment or submited feedback for your notes via email. - The email address is base64 encoded to provide some basic protection from bots. -- The subject line of the email will be taken from the page Title where the button is clicked. +- The subject line of the email will be taken from the page title where the button is clicked. - You can specify on what notes the button should be displayed or excluded. - The label on the button can also be customised. @@ -17,13 +17,12 @@ The Reply By Email Button is disabled by default. To enable it, you can add the Minimal configuration: ```ts Component.ReplyByEmail({ - username: "Y29udGFjdA==", // "contact" encoded in base64, as in contact@example.com - domain: "ZXhhbXBsZS5jb20=", // "example.com" encoded in base64, as in contact@example.com + email: "contact@example.com" }), ``` You can specify under which notes to display the button by adding the following: ```ts -includeTitles: ["Welcome to Quartz 4", "Reply by Email Button"], +includeTitles: ["Welcome to Quartz 4", "Reply by Email Button", "Contact"], ``` Alternatively, you can include the button by default by ommiting the `includeTitles` line, and specify notes under which the button should not be displayed: ```ts @@ -42,8 +41,7 @@ The natural placement for the Reply By Email Button is within `afterBody` in the ```ts afterBody: [ Component.ReplyByEmail({ - username: "Y29udGFjdA==", // "contact" encoded in base64, as in contact@example.com - domain: "ZXhhbXBsZS5jb20=", // "example.com" encoded in base64, as in contact@example.com + email: "contact@example.com", // The email address to be linked to // includeTitles: ["Welcome to Quartz 4"], // You can specify which page titles to include or comment out the line to include on all pages excludeTitles: ["Welcome to Quartz 4", "Home"], // You can specify which page titles to exclude when includeTitles is empty buttonLabel: "Submit feedback by email" // You can override the default button text "Reply by email"