Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/orchidjs/eleventy-plugin-ids

@11ty plugin for adding ids to html headings and other elements
https://github.com/orchidjs/eleventy-plugin-ids

Last synced: 3 months ago
JSON representation

@11ty plugin for adding ids to html headings and other elements

Awesome Lists containing this project

README

        

# eleventy-plugin-ids

@11ty plugin for adding ids to html headings and other elements

```html

Foo Bar


```
will become

```html

Foo Bar


```

## Installation

```
npm install @orchidjs/eleventy-plugin-ids
```

## Basic Usage

Add eleventy-plugin-ids to your .eleventy.js file
```js
module.exports = function(eleventyConfig) {
//...

const anchors_plugin = require('@orchidjs/eleventy-plugin-ids');
eleventyConfig.addPlugin(anchors_plugin);

//...
}
```

## Settings

```js
module.exports = function(eleventyConfig) {
//...

const anchors_plugin = require('@orchidjs/eleventy-plugin-ids');
eleventyConfig.addPlugin(anchors_plugin,{
selectors: ['h1','h2','h3','h4','h5','h6'],
prefix: 'custom-id-prefix-',
formatter: function(element,existing_ids_array){
return '--generate-a-custom-id-here-',
}
});

//...
}
```