Configuration
Learn how to configure NotionDir.
NotionDir is designed to be simple to use. All the configuration can be done in the notiondir-template/src/site-config.ts file.
| Property | Type | Description |
|---|---|---|
| title | string | Website title |
| description | string | Website description |
| domainName | string | Website domain name, example: https://notiondir.com/ |
| notionListPageUrl | string | The notion database page url, the page must be public |
| navigation | never[] | Navigation configuration |
| submitButton | { label: string, url: string } | Submit button configuration |
| theme | 'wind' | 'nova' | Theme selection |
| analytics | { plausibleUrl: { domain: string, scriptUrl: string }, gaId: string } | Analytics configuration (optional) |
title
The title of the website.
While title and description will be read from the notion page, for SEO
purposes, it is recommended to set them in the site-config.ts file as well.
description
The description of the website.
domainName
The domain name of the website, example: https://notiondir.com/
notionListPageUrl
The notion database page url, the page must be public.
Please note, the page must be a database page, not a normal page.
navigation
The navigation configuration.
submitButton
The submit button configuration.
theme
The theme selection. For now, two themes are available: wind and nova.
See more about the themes in the themes section.
analytics
The analytics configuration. See more about the analytics in the analytics section.