https://github.com/ahmadnassri/metalsmith-jade
Metalsmith plugin to convert jade files
https://github.com/ahmadnassri/metalsmith-jade
lib metalsmith node
Last synced: 4 months ago
JSON representation
Metalsmith plugin to convert jade files
- Host: GitHub
- URL: https://github.com/ahmadnassri/metalsmith-jade
- Owner: ahmadnassri
- License: mit
- Created: 2015-04-24T19:37:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T20:53:38.000Z (5 months ago)
- Last Synced: 2025-02-10T01:12:19.093Z (4 months ago)
- Topics: lib, metalsmith, node
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/metalsmith-pug
- Size: 127 KB
- Stars: 21
- Watchers: 5
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Metalsmith Pug
Metalsmith plugin to convert pug files
[![license][license-img]][license-url]
[![release][release-img]][release-url]
[![semantic][semantic-img]][semantic-url]
## Install
``` bash
npm install metalsmith-pug
```
## Usage
I recommend using an optimized build matching your Node.js environment version, otherwise, the standard `require` would work just fine with any version of Node `>= v4.0` .
``` js
/*
* Node 7
*/
const metalsmith-jade = require('metalsmith-jade/lib/node7')
/*
* Node 6
*/
const metalsmith-jade = require('metalsmith-jade/lib/node6')
/*
* Node 4 (Default)
* Note: additional ES2015 polyfills may be required
*/
var metalsmith-jade = require('metalsmith-jade')
```
## API
Pass `options` to the pug plugin and pass it to Metalsmith with the `use` method:
``` js
import Metalsmith from 'metalsmith'
import pug from 'metalsmith-pug'
const options = {
pretty: false,
locals: {
postName: 'good post name'
},
filters: {
foo: block => block.replace('foo', 'bar')
}
}
new Metalsmith(__dirname)
.use(pug(options))
```
## CLI
You can also use the plugin with the Metalsmith CLI by adding a key to your `metalsmith.json` file:
``` json
{
"plugins": {
"metalsmith-pug": {
"pretty": false
}
}
}
```
All options are passed directly to pug. If `options` has a `locals` key, that will be passed along to pug.
## Options
any of the `options` parameters for [`pug`][] with the additional plugin specific properties below:
| Name | Type | Required | Default | Details |
|-------------------|-----------|----------|---------|---------------------------------------------------------|
| **`useMetadata`** | `Boolean` | ❌ | `false` | Expose Metalsmith's global metadata to the pug template |
| **`locals`** | `Object` | ❌ | `{}` | Pass additional locals to the template |
| **`filters`** | `Object` | ❌ | `{}` | register functions to be used as template filters |
[`pug`]: http://jade-lang.com/api/
----
> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •
> Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)
[license-url]: LICENSE
[license-img]: https://badgen.net/github/license/ahmadnassri/node-metalsmith-pug
[release-url]: https://github.com/ahmadnassri/node-metalsmith-pug/releases
[release-img]: https://badgen.net/github/release/ahmadnassri/node-metalsmith-pug
[semantic-url]: https://github.com/ahmadnassri/node-metalsmith-pug/actions?query=workflow%3Arelease
[semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue