Most of the elements in the siteconfig.json file, which you may want to customize in your themeconfig.json file, have three settings of enabled, visible and defaultValue that can be set to true or false. For example:
"logo": {
"enabled": true,
"visible": true,
"defaultValue": true
Use the following two tables for information about:
-
the enabled, visible and defaultValue settings and how to use them,
-
what each element in the siteconfig.json file defines, with any additional settings.
Pro Tip: The JSON standard is a commonly-used data interchange format with a lot of freely available information to help your understanding. There are also dedicated JSON viewers and editors available, such as the Notepad++ JSON viewer plugin, which may make it easier to work in the JSON files - making the hierarchy more obvious, for example.
Use the different settings and values as follows.
True |
False |
|
---|---|---|
enabled |
The item can be switched ON or OFF in the settings menu (21 in image below). |
The item is grayed out in the settings menu and its default value (ON or OFF) cannot be changed. |
visible |
The item is visible in the settings menu (21 in image below). |
The item is not visible in the settings menu. |
defaultValue |
The item is visible in the site. |
The item is not visible in the site. |
Use the element descriptions and any additional settings, as follows.
Annotation |
Element |
Description and any additional settings |
---|---|---|
"title": "siteConfig", |
Provides information about versioning etc. Do not change |
|
1 |
"navigation": |
Displays or hides the navigation bar. Overrides defaultValue selections made for the "header" element.
|
2 |
"disqus": |
Defines your Disqus customer key, as acquired separately from Disqus.
Also set the "disqus" element below. |
"imageClickPopOver": |
Controls whether clicking an image shows an expanded view.
|
|
"searchResultSize": |
Sets the number of search results shown per page. The default is 10.
|
|
3 |
"share": { |
Controls which social media icons appear in the Share popup.
|
4 |
"footer": { |
Controls whether the footer appears on the landing page and content page.
|
5 |
"scroll": { |
Controls how the content pages scroll when viewing the site on two different device types - page by page or infinite scroll.
|
2 |
"disqus": { |
If the "disqus" element at the beginning of the file contains your Disqus customer key (acquired separately from Disqus), these selections will apply; but if it is empty, these settings will be invisible or disabled. Controls the Disqus widget on the site and the Disqus option on the heading context menu.
|
6 |
"favourites_pages": { |
Controls the My Favourite Pages widget on the site and the Add to Favourites option on the heading context menu.
|
7 |
"glossary":{ |
Controls whether the Glossary tab is shown or not.
|
8 |
"hambuger_menu":{ |
Sets the default for showing or hiding the Hamburger menu, which controls the navigation menu containing the Table of Contents, Index and Glossary. |
9 |
"header": { |
If the "navigation" element at the beginning of the file is set to true, these selections will apply; but if it is set to false, these settings will have no effect. Controls the navigation bar across the top of the site.
|
10 |
"index": { |
Controls whether the Index tab is shown or not.
|
11 |
"logo": { |
Controls whether the logo is shown or not.
|
12 |
"most_searches": { |
Controls the Most Recent Searches widget on the site.
|
13 |
"my_savedSearches":{ |
Controls the My Saved Searches widget on the site.
|
14 |
"recent_pages":{ |
Controls the Recently Updated pages widget on the site.
|
15 |
"related_links":{ |
Shows or hides the related topics links (as set in Related Topics in Author) on the topic heading.
|
16 |
"resources": { |
Controls the Resources widget on the site.
|
17 |
"section_menu": { |
Sets the default for showing or hiding the widgets section menu on the right.
|
18 |
"toc": { |
Controls the Table of Contents (TOC).
|
19 |
"translate":{ |
This element is designed for configuring automatic translation of your Magellan site using the Google translation API with a purchased API key. This Magellan feature is currently in Beta and will be fully supported in a future release. |
20 |
"what_section":{ |
Controls the What`s in this section widget on the site.
|
21 |
"Filter": |
Controls the languages that appear on the language selector menu, and filters for mutli-publication sites.
|
22 |
"toc": { |
|