Publican.lib

Publican.lib is a set of template and utility functions that help you generate static web sites with Publican. The Publican.dev website uses Publican.lib.

Import everything #

Install Publican.lib in your Publican project:

terminal

npm install publican.lib

Import it into your Publican configuration file:

publican.config.js excerpt

// Publican configuration
import { libInit } from 'publican.lib';

Then pass publican and tacs to the libInit() initialization function before calling await publican.build();

publican.config.js excerpt

// ...set Publican defaults...

// initialize publican.lib
libInit(publican, tacs);

// optionally set the default language
tacs.lib.format.setLocale( 'en-US' );

// build
await publican.build();

You can then use:

• utility functions in configuration files
• event hook functionality
• format, nav, and feed functions in your templates
• replacement strings in content.

Import individual utilities #

Rather than using all functionality, you can choose to import specific functions. For example, to use all formatting and the nav.pagination() functions only:

publican.config.js excerpt

// Publican configuration
import { Publican, tacs } from 'publican';

// import from Publican.lib
import * as format from 'publican.lib/format';
import { pagination } from 'publican.lib/nav';

// create a global functions object
tacs.fn = tacs.fn || {};

// use all tacs.fn.format functions in templates
tacs.fn.format = format;

// use tacs.fn.nav.pagination() function in templates
tacs.fn.nav = { pagination };