theme.json

{
	"name": "Halfmoon",
	"description": "A customizable documentation and blog theme based on the Halfmoon framework with a built-in dark and light mode",
	"author": "Marc Anton Dahmen",
	"license": "MIT",
	"masks_": {
		"page": [
			"formatDate",
			"imageAppleTouchIcon",
			"imageFavicon",
			"imageLogo",
			"labelShowAll",
			"locale",
			"notificationNoSearchResults",
			"placeholderSearch",
			"urlSearchResults"
		],
		"shared": [
			"+main",
			"checkboxShowInFooter",
			"checkboxShowInNavbar",
			"checkboxHideTitle",
			"metaDescription",
			"metaTitle"
		]
	},
	"tooltips": {
		"+main": "The main content of the page",
		"actionButtonClass": "The Halfmoon class for the action button: <br>btn-primary<br>btn-secondary<br>btn-danger<br>btn-success<br>btn-link",
		"brand": "In case there is no logo defined, this field can be used for any kind of markup like HTML or SVG to serve as the brand of the site",
		"cardImageRelativeHeight": "The relative height of a card image in percent &mdash; the default is 75%",
		"checkboxHideTableOfContents": "Hide the table of contents sidebar",
		"checkboxHideThumbnails": "Hide thumbnails within a masonry page grid",
		"checkboxHideTitle": "Hide the page title and tags",
		"checkboxNavbarMenuRight": "Move the navigation menu to the right",
		"checkboxShowAllPagesInPagelist": "Show not only children but all pages in the pagelist",
		"checkboxShowInFooter": "Show a link to this page in the footer",
		"checkboxShowInNavbar": "Show a link to this page in the navbar",
		"customProperties": "Custom CSS properties to customize the main styles of the Halfmoon framework &mdash; check out available properties <a href=\"https://github.com/halfmoonui/halfmoon/blob/master/css/halfmoon-variables.css\" target=\"_blank\">here</a>",
		"filterPagelistByUrl": "Filters the pagelist by URLs matching a given regular expression like for example '(/portfolio|/blog)'",
		"formatDate": "The format for displaying the date of a page &mdash; you can find more information about date formats <a href=\"https://www.php.net/manual/en/datetime.format.php\">here</a>",
		"imageAppleTouchIcon": "The file to be used as Apple touch icon",
		"imageFavicon": "The file to be used as favicon",
		"imageLogo": "The logo image",
		"imageOpenGraph": "A glob pattern to select a preview image for Twitter, Facebook or similar social network cards. This could be for example `*.png, *.jpg`",
		"imageTeaser": "A glob pattern or a filename to define the teaser image for a page",
		"itemsFooter": "Additional markup to be included right before the closing body tag",
		"itemsHeader": "Additional markup to be included right before the closing head tag",
		"itemsPerPage": "Limit the items of the pagelist per page",
		"labelShowAll": "The text for show all button",
		"locale": "The locale information to format date and time according to like 'en_EN' or 'de_DE'",
		"metaDescription": "An optional meta description to be used for Twitter, Facebook or similar social network cards",
		"metaTitle": "An optional meta title to be used for the browser title bar and links used on Twitter, Facebook or similar social networks",
		"notificationNoSearchResults": "Notification text for an empty list of search results",
		"placeholderSearch": "Placeholder text for the search field of the main menu",
		"sortPagelist": "Sorting of the pages in a blog pagelist. Note that the sorting and filtering buttons should be hidden in case this variable is defined! The default is 'date desc'. You can choose any other page variable in combination with an order (asc or desc) like ':path asc'",
		"tableOfContentsTitle": "The title of the table of contents sidebar",
		"urlActionButtonTargetPage": "The URL for an optional action button in the navbar",
		"urlContextForPagelist": "Defines an alternative URL to be used as the pagelist's parent page, instead of the current one",
		"urlSearchResults": "The URL of the search results page &mdash; defaults to the homepage"
	}
}