config.json stores configuration variables for the dex as a dictionary in JSON format. config.json has the following parameters:
{ 'dexname': 'Dexweb Docs',
'author': 'Noorul Ali',
'index_template': '',
'page_template': '',
'page_javascript': '',
'index_javascript': '',
'index_list_type_para': false,
'index_list_no_page_link_only': true,
'publish': {'dest': 'git@github.com:matrixdex/dexweb.git', 'branch': 'main', 'site_path': 'docs'}
}dexname: String of dex name. Visible in title section of index page, footer of every page and as HTML title. Default value: 'sample dex'
author: String of dex author. Default value: 'dexweb'
index_template: String of HTML index page template. Generates HTML index page. Editable in config.json for custom features on index page. Add custom JavaScript in script tag to embed JavaScript in index page.
page_template: String of HTML page template for all pages (except index). Generates HTML webpages using data from data.json. Editable in config.json for custom features on each page. Add custom JavaScript in script tag to embed JavaScript in every page.'
page_javascript: String of JavaScript in a script tag. Inserted before </head> in every page (except index). Default value: ''
index_javascript: String of JavaScript in a script tag. Inserted before </head> in the index page. Default value: ''
index_list_type_para: Boolean (true/false). Default value: false. If true, links on index page have descriptions attached. The first string in the body list of each webpage is attached as description to its link on the index page. If false, links on index page only use title of each webpage.
index_list_no_page_link_only: Boolean (true/false). Default value: true. If true, pages with only 1 string in their body list only containing a hyperlink are directly hyperlinked on the link of that page in the index page. For example, this object in data.json
[{'title': 'Research Engine', body:['< a href='https://alinoorul.github.io/researchengine'>Research Engine< /a>']}]If 'index_list_no_page_link_only' == true, this object generates a hyperlink (Research Engine) in the index page to the webpage https://alinoorul.github.io/researchengine. It does not link to a webpage in the dex but the webpage given by the hyperlink.
If 'index_list_no_page_link_only' == false, this object generates a hyperlink (Research Engine) in the index page to researchengine.html webpage in the dex. It links to a webpage in the dex.
publish: Object. Optional. Sets how dexweb.Dexweb().publish() publishes the dex online. Without it, the dex is only built. See publishing dex online for its options.