fix(code): Add ability to disable SEO optimization for titles

Author: obenjiro

src/transform/plugins/anchors/index.ts

@@ -76,12 +76,14 @@ const removeCustomIds = (token: Token) => {
 interface Options {
     extractTitle?: boolean;
     supportGithubAnchors?: boolean;
+    disableSEOFixForTitles?: boolean;
     transformLink: (v: string) => string;
     getPublicPath?: (options: Options, v?: string) => string;
 }
 
 const index: MarkdownItPluginCb<Options> = (md, options) => {
-    const {extractTitle, path, log, supportGithubAnchors, getPublicPath} = options;
+    const {extractTitle, path, log, supportGithubAnchors, getPublicPath, disableSEOFixForTitles} =
+        options;
 
     const plugin = (state: StateCore) => {
         /* Do not use the plugin if it is included in the file */
@@ -143,9 +145,16 @@ const index: MarkdownItPluginCb<Options> = (md, options) => {
                 const anchorTitle = removeCustomId(title).replace(/`/g, '');
                 allAnchorIds.forEach((customId) => {
                     const setId = id !== customId;
-                    const linkTokens = createLinkTokens(state, customId, anchorTitle, setId, href);
-
-                    inlineToken.children?.unshift(...linkTokens);
+                    if (!disableSEOFixForTitles) {
+                        const linkTokens = createLinkTokens(
+                            state,
+                            customId,
+                            anchorTitle,
+                            setId,
+                            href,
+                        );
+                        inlineToken.children?.unshift(...linkTokens);
+                    }
 
                     if (supportGithubAnchors) {
                         const ghLinkTokens = createLinkTokens(state, ghId, anchorTitle, true, href);

test/anchors.test.ts

@@ -144,4 +144,34 @@ describe('Anchors', () => {
             expect(result[1]).toBe('Test');
         });
     });
+
+    describe('with disableSEOFixForTitles', () => {
+        it('should not add anchor links when disableSEOFixForTitles is true', () => {
+            const {
+                result: {html},
+            } = transform('## Test heading', {
+                plugins: [includes, anchors],
+                path: mocksPath,
+                root: dirname(mocksPath),
+                getPublicPath,
+                disableSEOFixForTitles: true,
+            });
+
+            expect(html).toEqual('<h2 id="test-heading">Test heading</h2>\n');
+        });
+
+        it('should not add anchor links for custom anchors when disableSEOFixForTitles is true', () => {
+            const {
+                result: {html},
+            } = transform('## Test heading {#custom-id}', {
+                plugins: [includes, anchors],
+                path: mocksPath,
+                root: dirname(mocksPath),
+                getPublicPath,
+                disableSEOFixForTitles: true,
+            });
+
+            expect(html).toEqual('<h2 id="custom-id">Test heading</h2>\n');
+        });
+    });
 });