docpad-plugin-pug
Advanced tools
Adds support for the Pug templating engine to DocPad
Convention: anything.pug
docpad install pug
Before you get started with Pug, it is important to be aware of one thing. The majority of support questions that come through with DocPad, aren't actually DocPad issues, but Pug issues. People confusing the syntax, Pug doing it's own templating magic, things like that.
The DocPad team recommends you try one of the many other amazing templating engines that are available, over trying to use Pug.
If you still insist on using Pug, please be aware, Pug will be a slippery slope, but luckily there are determined Pug users here to help :)
---
title: "Pug Example"
---
h1= document.title
ul
each page in getCollection("html").findAll({isPage:true}).toJSON()
li(class!=page.id === document.id ? 'active' : 'inactive')
a(href=page.url)
= page.title
Use just like any pug template. However, we do add any docpad template helpers you may have as pug filters. There are two ways you can use these filters:
-# first way, calls the template helper like: myTemplateHelper("content", {opt1="blah",opt2="blah",opt3=true})
:myTemplateHelper(opt1=blah,opt2=blah,opt3)
content
-# second way, calls the template helper like: myTemplateHelper(arg1, arg2)
:myTemplateHelper(args)
arg1
arg2
NOTE: Not all template helpers support being called this way. If it doesn't work, we'd recommend using the text plugin to render eco which includes your template helper call. See following section.
All JSTransformers can now be used as pug filters.
You can use the text plugin to render different parts of your template with different markups that are support by your docpad setup. Once installed, you can do things like:
:t(render="markdown")
here is some *markdown*
:t(render="html.md.eco")
here is some <%-'eco'.toUpperCase()%> to *markdown* to html
:t(render="html.eco")
my url is <%-@document.url%>
Discover the release history by heading on over to the HISTORY.md file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under:
v2.6.0 2020 October 29
FAQs
Adds support for the Pug templating engine to DocPad.
The npm package docpad-plugin-pug receives a total of 6 weekly downloads. As such, docpad-plugin-pug popularity was classified as not popular.
We found that docpad-plugin-pug demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.