Skip to content

feat(tools): 11ty plugin anchors #2342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bennypowers merged 4 commits into from
Feb 6, 2023
Merged

feat(tools): 11ty plugin anchors #2342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d9ad9d
feat(tools): 11ty plugin anchors
bennypowers Feb 3, 2023
9a9627f
Merge branch 'main' into feat/tools/11ty-anchors
bennypowers Feb 4, 2023
45049ef
chore: add anchors plugin to package.json
bennypowers Feb 4, 2023
30a8817
Merge branch 'main' into feat/tools/11ty-anchors
zeroedin Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/tools-11ty-anchor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@patternfly/pfe-tools": minor
---
✨ Added `anchors` 11ty plugin, based on [@orchidjs/eleventy-plugin-ids][npm]

[npm]: https://npm.im/@orchidjs/eleventy-plugin-ids
15 changes: 9 additions & 6 deletions eleventy.config.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
const { EleventyRenderPlugin } = require('@11ty/eleventy');
const AnchorsPlugin = require('@orchidjs/eleventy-plugin-ids');
const SyntaxHighlightPlugin = require('@11ty/eleventy-plugin-syntaxhighlight');
const DirectoryOutputPlugin = require('@11ty/eleventy-plugin-directory-output');

const PfeAssetsPlugin = require('./docs/_plugins/pfe-assets.cjs');

const AnchorsPlugin = require('@patternfly/pfe-tools/11ty/plugins/anchors.cjs');
const CustomElementsManifestPlugin = require('@patternfly/pfe-tools/11ty/plugins/custom-elements-manifest.cjs');
const OrderTagsPlugin = require('@patternfly/pfe-tools/11ty/plugins/order-tags.cjs');
const TodosPlugin = require('@patternfly/pfe-tools/11ty/plugins/todos.cjs');
const TocPlugin = require('@patternfly/pfe-tools/11ty/plugins/table-of-contents.cjs');

const markdownItAnchor = require('markdown-it-anchor');

/** @param {import('@11ty/eleventy/src/UserConfig')} eleventyConfig */
module.exports = function(eleventyConfig) {
eleventyConfig.amendLibrary('md', md => md.use(markdownItAnchor));

Expand Down Expand Up @@ -50,16 +52,17 @@ module.exports = function(eleventyConfig) {

/** Add IDs to heading elements */
eleventyConfig.addPlugin(AnchorsPlugin, {
formatter(element, existingids) {
exclude: /\/components\/.*\/demo\//,
formatter($, existingids) {
if (
!existingids.includes(element.getAttribute('id')) &&
element.hasAttribute('slot') &&
element.closest('pf-card')
!existingids.includes($.attr('id')) &&
$.attr('slot') &&
$.closest('pf-card')
) {
return null;
} else {
return eleventyConfig.javascriptFunctions
.slug(element.textContent)
.slug($.text())
.replace(/[&,+()$~%.'":*?!<>{}]/g, '');
}
},
Expand Down
Loading