feat: siteConfig.markdown.parseFrontMatter hook

[slorber]

Motivation

The ability to provide your own markdown front matter parsing logic unlocks many fancy use cases.

Fix #5568

Example

export default {
  markdown: {
    parseFrontMatter: async (params) => {
      // Reuse the default parser
      const result = await params.defaultParseFrontMatter(params);

      // Process front matter description placeholders
      result.frontMatter.description =
        result.frontMatter.description?.replaceAll('{{MY_VAR}}', 'MY_VALUE');

      // Create your own front matter shortcut
      if (result.frontMatter.i_do_not_want_docs_pagination) {
        result.frontMatter.pagination_prev = null;
        result.frontMatter.pagination_next = null;
      }

      // Rename an unsupported front matter coming from another system
      if (result.frontMatter.cms_seo_summary) {
        result.frontMatter.description = result.frontMatter.cms_seo_summary;
        delete result.frontMatter.cms_seo_summary;
      }

      return result;
    },
  },
}

Test Plan

CI + preview + dogfooding

Test links

https://deploy-preview-9624--docusaurus-2.netlify.app/

Test page that gets unlisted thanks to parseFrontMatter:
https://deploy-preview-9624--docusaurus-2.netlify.app/tests/docs/tests/visibility/force-unlisted

Docs:

• https://deploy-preview-9624--docusaurus-2.netlify.app/docs/markdown-features/#front-matter
• https://deploy-preview-9624--docusaurus-2.netlify.app/docs/api/docusaurus-config/#parseFrontMatter

[netlify]

✅ [V2]

Name	Link
🔨 Latest commit	516016a
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/657cf59067c6180008283958
😎 Deploy Preview	https://deploy-preview-9624--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[github-actions]

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 71	🟢 98	🟢 100	🟢 100	🟠 89	Report
/docs/installation	🟠 87	🟢 98	🟢 100	🟢 100	🟠 89	Report
/docs/category/getting-started	🟠 76	🟢 100	🟢 100	🟢 90	🟠 89	Report
/blog	🟠 74	🟢 100	🟢 100	🟢 90	🟠 89	Report
/blog/preparing-your-site-for-docusaurus-v3	🟠 64	🟢 97	🟢 100	🟢 100	🟠 89	Report
/blog/tags/release	🟠 74	🟢 100	🟢 100	🟠 80	🟠 89	Report
/blog/tags	🟠 77	🟢 100	🟢 100	🟢 90	🟠 89	Report

[github-actions]

Size Change: +712 B (0%)

Total Size: 926 kB

Filename	Size	Change
website/.docusaurus/globalData.json	59.2 kB	+220 B (0%)
website/build/assets/js/main.********.js	716 kB	+492 B (0%)

ℹ️ View Unchanged

Filename	Size
website/build/assets/css/styles.********.css	114 kB
website/build/index.html	37.6 kB

_{compressed-size-action}

[argos-ci]

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	🧿 Changes detected (Review)	125 changes	Jan 5, 2024, 6:57 PM