Skip to content

General settings (VUUKLE_CONFIG)

The keys directly on VUUKLE_CONFIG (not nested under comments, emotes, etc.) configure things that apply to every widget on the page — article metadata, theme, language, and global behaviour flags.

<script>
var VUUKLE_CONFIG = {
apiKey: 'YOUR_API_KEY', // public API key
articleId: 'post-12345', // unique per article
title: 'Article title',
url: 'https://example.com/article-slug',
img: 'https://example.com/img/article.jpg',
tags: 'tag1, tag2, tag3',
author: 'Article author',
link: 'https://[your-canonical-url-protocol]',
recommendationsWideImages: false,
globalRecommendations: false,
wordpressSync: 'true',
language: 'en',
theme: {
color: '#10e9ba',
darkMode: false,
},
};
// ⛔ DON'T EDIT BELOW THIS LINE
(function () {
var d = document, s = d.createElement('script');
s.async = true;
s.src = 'https://cdn.vuukle.com/platform.js';
(d.head || d.body).appendChild(s);
})();
</script>
KeyTypeDescription
apiKeystringPublic API key from the dashboard
articleIdstring | numberUnique article identifier — stable across page loads
titlestringArticle title — used in shared URLs and OG previews
urlstringCanonical article URL
imgstringArticle hero image URL
tagsstringComma-separated tags for analytics and recommendations
authorstringAuthor name
linkstringProtocol/host for recommendation URLs
recommendationsWideImagesboolUse wide cards in recommendations
globalRecommendationsboolInclude articles from the global Vuukle network
wordpressSyncstringSync with the WordPress plugin’s article model
languagestringUI language code (en, es, de, …)
theme.colorhex stringAccent colour
theme.darkModeboolForce dark theme

For widget-specific configuration (comments, emotes, sharebar, newsfeed) see the per-widget pages:

For full type definitions see the VUUKLE_CONFIG reference.

Was this page helpful?
Help us improve — drop a note or open the dashboard.