Base theme in docify
This is a parent theme for user guide theme and blog theme.
This theme contains basic templates setup and enables the most common plugins and components.
Layouts
- master - contains the basic frame for the HTML5 page. This layout includes all the assets from the components used by the base theme. In also enables individual pages to inject custom (page specific) scripts and styles by using the corresponding attributes in the metadata
scripts: - /page1/script1.js - /page1/script2.js styles: - /page1/style1.css - /page1/style2.css
- void - empty layout, inherited from master layout
Standard Library Components
Components
Plugins:
Theme Specific Components
Date
This include allows to add a current date with the specified format
{% date format: yyyy-MM-dd %}
Legal
Generates a footer with the references to legal information (i.e. Terms Of Use, Privacy Policy, Cookies Policy etc.) and copyright notices
Specify the company name (site url is default) and list of names and corresponding links to legal urls
$legal:
company: Xarial Pty Limited
links:
Terms Of Use: /terms-of-use/
Privacy: /privacy-policy/
Cookies: /cookies-policy/
<div class="footer"> {% legal %} </div>
Page Language
Component resolves the language of the page and add this to a HTML page header
<!DOCTYPE html> <html lang="en"> <head>
Language is extracted from the lang attribute of the page metadata or configuration for the global option.
Default value is en and can be assigned via default-lang attribute of the include.
Site Header
Component provides a generic responsive layout for the site header. It includes title of the site, description and icon.
<div class="layout-header">{% site-header %}</div>
Width of the icon can be specified via icon-width attribute (default is 75px). show-title indicates if the title needs to be displayed (default true).
The title and description of the site are extracted from the corresponding attributes of the main page.