Static Pages / Twig renderer
Renders page data via twig templates.
Uses the Twing and Marked packages under the hood. Everything provided by Twing and Marked is also exported from this package (for advanced configuration).
This package is part of the StaticPagesJs project, see:
- Documentation: staticpagesjs.github.io
- Core: @static-pages/core
Usage
import twigRenderer from '@static-pages/twig-renderer';
const renderer = twigRenderer({
viewsDir: 'myViews',
view: 'content.twig',
});
const pageData = { title: 'Page header', body: 'My Content' };
renderer(pageData); // returns the rendered page as string in a promise.Options
| Option | Type | Default value | Description |
|---|---|---|---|
view |
string | (d: Data) => string |
main.twig |
Template to render. If it's a function it gets evaluated on each render call. |
viewsDir |
string | string[] |
views |
One or more directory path where the templates are found. |
globals |
object |
{} |
Additional properties loaded to the twig environment as globals. |
functions |
TwigFunctionMap |
{} |
Functions in an object that gets loaded to the twig environment. |
filters |
TwigFilterMap |
{} |
Filters in an object that gets loaded to the twig environment. |
advanced |
(env: TwingEnvironment) => void |
() => undefined |
Allows advanced configuration via access to the env twig environment. |
markedEnabled |
boolean |
true |
Register a markdown filter; uses marked. |
markedOptions |
marked.MarkedOptions |
see markedOptions section | Custom options for the marked markdown renderer. |
Custom types used in the table above:
type TwigFunctionMap = Record<string, TwingCallable<unknown> | [
TwingCallable<unknown>,
TwingCallableWrapperOptions,
]>;
type TwigFilterMap = Record<string, TwingCallable<unknown> | [
TwingCallable<unknown>,
TwingFilterOptions,
]>;Example for TwigFunctionMap and TwigFilterMap:
export const myTwigFiltersOrFunctions = {
asset(asset: string) {
return new URL(asset, '/site/assets/').toString();
},
json_formatted: [
d => JSON.stringify(d, null, 4),
{ is_safe: ['html'] }
],
};The defined functions above can be an async functions or regular sync functions. No restrictions like the underlying Twing package makes where you allowed to use async functions only.
markedOptions defaults
This package uses the default options of the official marked defaults:
In twig files there is a possibility to pass markdown options to the underlying markdown renderer. Example:
{{ '[foo](foo)'|markdown({ baseUrl: 'http://example.com' }) }}<p><a href="http://example.com/foo">foo</a></p>Additionally there is an inline option added to the available options. This removes the paragraphs tags. Example:
{{ '[foo](foo)'|markdown({ inline: true, baseUrl: 'http://example.com' }) }}<a href="http://example.com/foo">foo</a>