Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Preview

URL preview settings for Halloy.

Configuration

enabled

Enable or disable previews globally with a boolean, or selectively enable them for URLs matching specific regex patterns.

# Type: boolean or array of strings
# Values: true, false, or array of regex patterns
# Default: true

[preview]
enabled = true

Only show previews for matching URLs:

💡 Use toml multi-line literal strings '''\bfoo'd\b''' when writing a regex. This allows you to write the regex without escaping. You can also use a literal string '\bfoo\b', but then you can’t use ' inside the string.

Without literal strings, you’d have to write the above as "\\bfoo'd\\b"

[preview]
enabled = [
    '''https?://(www\.)?imgur\.com/.*''', 
    '''https?://(www\.)?dr\.dk/.*'''
]

exclude

Exclude URLs from showing previews by providing regex patterns.

# Type: array of strings
# Values: array of regex patterns
# Default: []

[preview]
exclude = []

Prevent previews from showing for matching URLs:

💡 Use toml multi-line literal strings '''\bfoo'd\b''' when writing a regex. This allows you to write the regex without escaping. You can also use a literal string '\bfoo\b', but then you can’t use ' inside the string.

Without literal strings, you’d have to write the above as "\\bfoo'd\\b"

[preview]
exclude = [
    '''https?://(www\.)?example\.com/.*''', 
    '''https?://(www\.)?spam-site\.net/.*'''
]

Request

Request settings for previews.

Image

Specific image preview settings.

Card

Specific card preview settings.