Predefined controls in the engine
The markdown site engine comes with the following built-in controls:
- language
- title
- description
- keywords
- bootstrap-navbar
- side-menu
- control-search-button
language
Returns the current language. Its typical usage is in document files:
<!DOCTYPE html>
<html>
<head lang="{{ #language }}">
...
</head>
<body>
...
</body>
</html>
title
Returns the title metadata of the current content. When missing, returns a
default title defined as a localized resource. That requires a title
key
in the default.json
locale file. Its typical usage is in document files:
<!DOCTYPE html>
<html>
<head>
<title>{{ #title }}</title>
...
</head>
<body>
...
</body>
</html>
description
Returns the description metadata of the current content. Its typical usage is in document files:
<!DOCTYPE html>
<html>
<head>
<meta name="description" content="{{ #description }}" />
...
</head>
<body>
...
</body>
</html>
keywords
Returns the merged default keywords defined as a localized resource and the
keywords metadata of the current content. The former requires a keywords
key in the default.json
locale file. Its typical usage is in document files:
<!DOCTYPE html>
<html>
<head>
<meta name="keywords" content="{{ #keywords }}" />
...
</head>
<body>
...
</body>
</html>
bootstrap-navbar
Returns a Bootstrap version 3 style navigation bar. An example cab be seen on this site. For more information see the Menu system page and the Bootstrap site. Its typical usage is in layout files:
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
...
<div class="collapse navbar-collapse" id="navbar-collapse-menu">
{{ #bootstrap-navbar }}
</div><!-- /.navbar-collapse -->
...
</nav>
If search functionality is activated, a searchHint
key is required in the
default.json
locale file for the placeholder of the input field.
side-menu
Returns a vertical link list like a table of contents. An example cab be seen on this page. For more information see the Menu system page. Its typical usage is in layout files:
<div class="content">
...
<div class="col-lg-3 col-md-3 col-sm-3">
{{ #side-menu }}
</div>
<div class="col-lg-9 col-md-9 col-sm-9">
{{ content }}
</div>
...
</div>
control-search-button
Returns a client side JavaScript routine that supports content search. For more information see Content search. Its typical usage is in document files:
<!DOCTYPE html>
<html>
<head>
...
</head>
<body>
...
{{ #control-search-button }}
</body>
</html>