You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enhance documentation formatting and add new Permalinks tutorial
- Updated RATING-SYSTEM.md, README.md, STYLE-CUSTOMIZATION.md, and STYLES-ARCHITECTURE-RELEASE.md to improve readability with consistent use of bold and italic styles.
- Added a comprehensive PERMALINKS-TUTORIAL.md to guide users on configuring permalinks in both free and Pro versions, including examples and troubleshooting tips.
Copy file name to clipboardExpand all lines: docs/BEACON-WIDGET.md
+69-69Lines changed: 69 additions & 69 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,60 +6,60 @@ The Beacon is a floating help widget that provides self-service support with sea
6
6
7
7
### Core Functionality
8
8
9
-
-**Floating Button** - Customizable button that sits at the bottom right (or left) of the screen
10
-
-**Self-Service Search** - Search knowledge base articles with debounced AJAX search (500ms)
11
-
-**Smart Suggested Articles** - Context-aware articles using Related class for KB posts, recent articles elsewhere
12
-
-**Contact Form** - HTML email contact with beautiful template when articles don't help
13
-
-**Built-in Spam Protection** - Honeypot field plus anonymous rate limiting without storing IPs
14
-
-**Minimum Message Length** - Requires at least 30 characters before submitting (filterable)
15
-
-**Stacked Navigation** - Mobile-app-style layered interface for smooth UX
16
-
-**Responsive Design** - Works beautifully on desktop, tablet, and mobile devices
17
-
-**Fixed Search Box** - Search box locked at bottom using CSS Grid for optimal UX
18
-
-**Related Articles Integration** - Reuses existing Related class logic (DRY principle)
9
+
-__Floating Button__ – Customizable button that sits at the bottom right (or left) of the screen.
10
+
-__Self-Service Search__ – Search knowledge base articles with debounced AJAX search (500ms).
11
+
-__Smart Suggested Articles__ – Context-aware articles using Related class for KB posts, recent articles elsewhere.
12
+
-__Contact Form__ – HTML email contact with beautiful template when articles do not help.
13
+
-__Built-in Spam Protection__ – Honeypot field plus anonymous rate limiting without storing IPs.
14
+
-__Minimum Message Length__ – Requires at least 30 characters before submitting (filterable).
15
+
-__Stacked Navigation__ – Mobile-app-style layered interface for smooth UX.
16
+
-__Responsive Design__ – Works beautifully on desktop, tablet, and mobile devices.
17
+
-__Fixed Search Box__ – Search box locked at bottom using CSS Grid for optimal UX.
18
+
-__Related Articles Integration__ – Reuses existing Related class logic (DRY principle).
19
19
20
20
### Design Features
21
21
22
-
-**Customizable Appearance** - Colors, position, button style, and labels
23
-
-**Dark Mode Support** - Automatically adapts to user's color scheme preference
24
-
-**Smooth Animations** - Polished transitions and hover effects
25
-
-**Accessibility** - Keyboard navigation, focus states, and ARIA labels
26
-
-**Modern UI** - Clean, professional design with rounded corners and shadows
27
-
-**Smart Color Palette** - Setup wizard derives hover/text/link colors from your primary brand color while keeping the panel background white for readability
22
+
-__Customizable Appearance__ – Colors, position, button style, and labels.
23
+
-__Dark Mode Support__ – Automatically adapts to the user’s color scheme preference.
24
+
-__Smooth Animations__ – Polished transitions and hover effects.
25
+
-__Accessibility__ – Keyboard navigation, focus states, and ARIA labels.
26
+
-__Modern UI__ – Clean, professional design with rounded corners and shadows.
27
+
-__Smart Color Palette__ – Setup wizard derives hover/text/link colors from your primary brand color while keeping the panel background white for readability.
28
28
29
29
## Configuration
30
30
31
31
### Admin Settings
32
32
33
-
Navigate to **Knowledge Base > Settings > Output** and scroll to the **Beacon Help Widget** section.
33
+
Navigate to __Knowledge Base → Settings → Output__ and scroll to the __Beacon Help Widget__ section.
34
34
35
35
#### Basic Settings
36
36
37
-
-**Enable Beacon** - Turn the beacon on/off
38
-
-**Button Position** - Choose bottom right or bottom left
39
-
-**Button Style** - Icon only, text only, or icon + text
40
-
-**Button Text** - Custom text for the button (default: "Help")
41
-
-**Beacon Color** - Primary color for button and UI elements (default: #617DEC)
37
+
-__Enable Beacon__ – Turn the beacon on/off.
38
+
-__Button Position__ – Choose bottom right or bottom left.
39
+
-__Button Style__ – Icon only, text only, or icon + text.
40
+
-__Button Text__ – Custom text for the button (default: “Help”).
41
+
-__Beacon Color__ - Primary color for button and UI elements (default: #617DEC)
42
42
43
-
> **Setup Wizard Color Tips:** When using the setup wizard, choosing a primary color automatically generates a full palette (button hover, text, panel text, and link hover colors) with contrast-aware values. The panel background is intentionally kept white to maintain content readability.
43
+
> __Setup Wizard Color Tips:__ When using the setup wizard, choosing a primary color automatically generates a full palette (button hover, text, panel text, and link hover colors) with contrast-aware values. The panel background is intentionally kept white to maintain content readability.
44
44
45
45
#### Content Settings
46
46
47
-
-**Greeting Message** - Welcome message when beacon opens (default: "Hi! How can we help you?")
48
-
-**Search Placeholder** - Placeholder text for search input (default: "Search for answers...")
47
+
-__Greeting Message__ – Welcome message when beacon opens (default: “Hi! How can we help you?”).
48
+
-__Search Placeholder__ – Placeholder text for search input (default: “Search for answers…”).
49
49
50
50
#### Contact Form Settings
51
51
52
-
-**Enable Contact Form** - Allow visitors to send messages
53
-
-**Contact Email** - Email address for form submissions (default: admin email)
54
-
-**Minimum Message Length** - Require visitors to enter at least 30 characters (default: 30, filterable)
52
+
-__Enable Contact Form__ – Allow visitors to send messages.
53
+
-__Contact Email__ – Email address for form submissions (default: admin email).
54
+
-__Minimum Message Length__ – Require visitors to enter at least 30 characters (default: 30, filterable).
55
55
56
56
#### Display Options
57
57
58
-
-**Display Location** - Choose where beacon appears:
59
-
-**Knowledge Base Only** (default) - Shows only on KB pages (singles, archives, taxonomies)
60
-
-**Entire Site** - Shows sitewide
61
-
-**Show on Mobile** - Display beacon on mobile devices
62
-
-**Enable Animations** - Smooth animations and transitions
58
+
-__Display Location__ – Choose where beacon appears:
59
+
-__Knowledge Base Only__ (default) – Shows only on KB pages (singles, archives, taxonomies).
60
+
-__Entire Site__ – Shows sitewide.
61
+
-__Show on Mobile__ - Display beacon on mobile devices
62
+
-__Enable Animations__ - Smooth animations and transitions
63
63
64
64
## JavaScript API
65
65
@@ -166,7 +166,7 @@ The beacon uses CSS Grid for a robust, modern layout:
166
166
}
167
167
```
168
168
169
-
**Benefits:**
169
+
__Benefits:__
170
170
171
171
- Search box always visible at bottom
172
172
- Articles scroll independently
@@ -178,8 +178,8 @@ The beacon uses CSS Grid for a robust, modern layout:
178
178
179
179
The search box appears at the bottom of:
180
180
181
-
1.**Home Screen** - Below suggested articles and contact button
0 commit comments