Configuration
Here's a list of available confuguration fields:
| Field | Type | Description |
|---|---|---|
| template | string | The url of the CSS template. |
| i18n | string | Internalization strings. Use one of these. |
| cname | string | Optional. The CNAME. |
| seo | SEO | SEO configurations. |
| user | User | User configurations. |
| links | Array of Link | A list of links/resources. |
| socials | Array of Social | Optional. A list of socials to display after the links. |
| analytics | boolean | Optional. Whether analytics should be enabled or not. Default's false. |
| scripts | Array of Script | Optional. A list of scripts to be included in the page. |
| credits | boolean | Optional. Whether the credits should be displayed or not. Default's true. |
User
| Field | Type | Description |
|---|---|---|
| name | string | The name to be displayed in the user's information. |
| bio | string | A short description of the website. |
| avatar | string | The url to the user's avatar. |
SEO
| Field | Type | Description |
|---|---|---|
| title | string | The website's title. |
| description | string | The website's description. |
Social
| Field | Type | Description |
|---|---|---|
| url | string | The social's url. |
| icon | string | The social's icon. Use Fontawesome's Icons |
| target | string | Optional. The target of the anchor element. Default's self. |
| name | string | Optional. The name of the url, will be used as aria-label. |
Link
| Field | Type | Description |
|---|---|---|
| name | string | The name of the link. |
| url | string | The link's url. |
| icon | string | The link's icon. Use Fontawesome's Icons |
| target | string | Optional. The target of the anchor element. Default's self. |
| sameAs | boolean | Optional. Whether itemprop="sameAs" should be included in the HTML element or not. Default's false. |
| privacy | boolean | Optional. Whether rel="noopener noreferrer" should be included in the HTML element or not. Default's false. |
| external | boolean | Optional. Whether rel="external" should be included in the HTML element or not. Default's false. |
Script
| Field | Type | Description |
|---|---|---|
| src | string | The src attribute of the <script tag |
| head | boolean | Optional. Whether the script should be in the <head> or in the <body> tag. Default's false. |
| ... | any | Optional. Any other key-value pair to add as attributes to the <script> tag. |