Add "usage" section in readme.md
This commit is contained in:
parent
453011285c
commit
03bcb6c08e
10
README.md
10
README.md
|
|
@ -18,6 +18,16 @@ export default function (eleventyConfig) {
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Add the extension ".pdf" to the permalink of the template's front matter.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
permalink: "my-file.pdf"
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
The `options` object can contain:
|
The `options` object can contain:
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "eleventy-plugin-pdf",
|
"name": "eleventy-plugin-pdf",
|
||||||
"version": "1.0.0",
|
"version": "1.0.1",
|
||||||
"description": "A plugin for 11ty that generates a pdf file from a template",
|
"description": "A plugin for 11ty that generates a pdf file from a template",
|
||||||
"main": "eleventy.config.js",
|
"main": "eleventy.config.js",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue