-
Notifications
You must be signed in to change notification settings - Fork 8
Configuration
The theme has various configuration options to customize the way theme works, including the look and feel. The configuration is saved in a JSON file at the root of the project. Below are the supported options:
"data": {
"type": "local",
"name": "data"
}
name property is used to indicate the folder in which the markdown files are stored. These Markdown files are used to store the changelog of each release.
Content folder's structure:
Folder
│
└───year-1
│ │ release-1.md
│ │ release-2.md
│ │ ...
│
└───year-2
│ │ release-n.md
│ │ release-n+1.md
│ │ ...
│
│ ...
"data": {
"type": "notion",
"name": "cbde2cdc46a14dfcaf5169eab225c30b"
}
name is the ID of the notion page.
Here is a sample notion page that can be used as a database for changelogs: https://polar-shoulder-194.notion.site/cbde2cdc46a14dfcaf5169eab225c30b
title - Title of the homepage
description - Description of the website
image - Image for social media link sharing
image - Logo of the website/product (empty if not logo)
text - Name of the website/product
title - The headline title present in the header
description - The sub-text below the header's title
The menu is an array of options that constitute the links to be shown in header.
"name": "Name of the link",
"link": "https://example.com"
Setting "type": "button" will change the way link appears to be shown as a button.
The menu item can also be a dropdown with more links:
"name": "Dropdown Menu Name",
"children": [
{
"name": "Link 1",
"link": "https://example.com"
},
{
"name": "Link 2",
"link": "https://example.com"
}
]
The footer can also have links to other parts of your product.
"linkTitle": "Heading of the links section",
"links": [
{
"name": "Footer Link 1",
"link": "https://example.com"
},
]
You can also configure the footer text by setting the copyright property.
The Theme supports multiple analytics providers by default.
type property specifies the provider. Supported values: "Google Analytics", "Simple Analytics" and "Plausible Analytics"
id property can host GA ID or plausible domain.