Skip to main content


Configure Emanates through a file#

Emanates allows the user to configure certain aspects of the blog through a configuration file. This file is supposed to be located at the root of the repository and should be named .emanates.js.

It will be a basic JavaScript configuration file.

Following is the default contents inside the config file:

module.exports = {    seo: {        site_name: "Blog | Built with Emanates",        site_description: "Just another blog built with Emanates",        site_keywords: "blog,emanates,built,emanates",        twitter_username: "@Emanates",        base_url: "",        logo: ""    },    favicon_url: "",    name: "Emanates Blog",    googleAnalytics: null,    commentsRepo: null}

Take a look at the latest configuration example in the repo which is the first to be updated!

Configuration options#

The configuration file takes all the options as shown in the above example. Following is a rundown of each with their explanation.

  • seo.site_name: Name of the site to be used in the metadata tags.
  • seo.site_description: Description of the site to be used in the metadata tags.
  • seo.site_keywords: Keywords for the metadata tags.
  • seo.twitter_username: Twitter username of the author for Twitter metadata tags.
  • seo.base_url: Base URL of the site, to build links for the post.
  • seo.logo: Logo URL of the site, so that posts show up with the logo in cards (such as in Twitter etc).
  • favicon_url: Favicon URL of the site. Default is NuxtJS icon.
  • name: Name of the site to be shown in sites like the navbar,
  • googleAnalytics: Configuration for Google Analytics. Read analytics setup
  • commentsRepo: Repo to be used for the comments. Should be in the form of username/reponame. Read comments setup