Skip to content

Commit a4c8406

Browse files
committed
Update the README for release.
1 parent dc08217 commit a4c8406

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

pug/README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
1-
# eleventy-plugin-pug
2-
Pug templates for Eleventy 3!
1+
# `@11ty/eleventy-plugin-pug`
2+
3+
Adds support for `.pug` files in Eleventy v3.0 and newer. Support for [`pug` was moved out of core as part of Project Slipstream](https://github.com/11ty/eleventy/pull/3074).
4+
5+
- 11ty Docs https://www.11ty.dev/docs/languages/pug/
6+
- `pug` package: https://pugjs.org/
7+
8+
## Installation
9+
10+
```sh
11+
npm install @11ty/eleventy-plugin-pug
12+
```
13+
14+
Add to your configuration file (ESM version shown):
15+
16+
```js
17+
import pugPlugin from "@11ty/eleventy-plugin-pug";
18+
19+
export default function (eleventyConfig) {
20+
eleventyConfig.addPlugin(pugPlugin);
21+
}
22+
```

0 commit comments

Comments
 (0)