From 792ee8ac4ca247b38232d7f8e1ba666c0b29f970 Mon Sep 17 00:00:00 2001 From: sebastienlorber Date: Fri, 6 Jan 2023 16:36:00 +0100 Subject: [PATCH] blog: support MDX truncate marker --- .../website/blog/mdx-blog-post.mdx | 12 ++++----- .../__tests__/__snapshots__/feed.test.ts.snap | 12 ++++----- .../src/__tests__/index.test.ts | 27 +++++++++++++++++++ .../src/options.ts | 2 +- .../2017-12-14-introducing-docusaurus.mdx | 2 +- ...-How-I-Converted-Profilo-To-Docusaurus.mdx | 2 +- .../blog/2018-09-11-Towards-Docusaurus-2.mdx | 2 +- .../2018-12-14-Happy-First-Birthday-Slash.mdx | 2 +- .../blog/2019-12-30-docusaurus-2019-recap.mdx | 2 +- website/blog/2020-01-07-tribute-to-endi.mdx | 2 +- .../blog/2021-01-19-docusaurus-2020-recap.mdx | 2 +- .../2021-03-09-releasing-docusaurus-i18n.mdx | 2 +- .../index.mdx | 2 +- .../index.mdx | 2 +- .../index.mdx | 2 +- .../blog/2022-09-01-docusaurus-2.1/index.mdx | 2 +- 16 files changed, 52 insertions(+), 25 deletions(-) diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/blog/mdx-blog-post.mdx b/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/blog/mdx-blog-post.mdx index 966e8cbce0..9c74a7fbf7 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/blog/mdx-blog-post.mdx +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/blog/mdx-blog-post.mdx @@ -1,5 +1,5 @@ --- -title: Full Blog Sample +title: MDX Blog Post date: 2021-03-05 --- @@ -7,7 +7,9 @@ date: 2021-03-05

HTML Heading 2

HTML Paragraph

-import Typography from '../../component/Typography' +{/* truncate */} + +import Typography from '../../component/Typography'; Import DOM @@ -25,12 +27,10 @@ import Typography from '../../component/Typography' - list2 - list3 - * list1 * list2 * list3 -Normal Text *Italics Text* **Bold Text** +Normal Text _Italics Text_ **Bold Text** -[link](https://v2.docusaurus.io/) -![image](https://v2.docusaurus.io/) +[link](https://v2.docusaurus.io/) ![image](https://v2.docusaurus.io/) diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap index ae568922d1..da2c72b5be 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/__snapshots__/feed.test.ts.snap @@ -21,7 +21,7 @@ exports[`atom filters to the first two entries 1`] = ` Test MDX with require calls

]]> - <![CDATA[Full Blog Sample]]> + <![CDATA[MDX Blog Post]]> https://docusaurus.io/myBaseUrl/blog/mdx-blog-post 2021-03-05T00:00:00.000Z @@ -53,7 +53,7 @@ exports[`atom has feed item for each post 1`] = ` Test MDX with require calls

]]> - <![CDATA[Full Blog Sample]]> + <![CDATA[MDX Blog Post]]> https://docusaurus.io/myBaseUrl/blog/mdx-blog-post 2021-03-05T00:00:00.000Z @@ -137,7 +137,7 @@ exports[`json filters to the first two entries 1`] = ` "id": "https://docusaurus.io/myBaseUrl/blog/mdx-blog-post", "content_html": "

HTML Heading 1

HTML Heading 2

HTML Paragraph

Import DOM

Heading 1

Heading 2​

Heading 3​

Heading 4​

Heading 5​

Normal Text Italics Text Bold Text

link\\"image\\"

", "url": "https://docusaurus.io/myBaseUrl/blog/mdx-blog-post", - "title": "Full Blog Sample", + "title": "MDX Blog Post", "summary": "HTML Heading 1", "date_modified": "2021-03-05T00:00:00.000Z", "tags": [] @@ -168,7 +168,7 @@ exports[`json has feed item for each post 1`] = ` "id": "https://docusaurus.io/myBaseUrl/blog/mdx-blog-post", "content_html": "

HTML Heading 1

HTML Heading 2

HTML Paragraph

Import DOM

Heading 1

Heading 2​

Heading 3​

Heading 4​

Heading 5​

Normal Text Italics Text Bold Text

link\\"image\\"

", "url": "https://docusaurus.io/myBaseUrl/blog/mdx-blog-post", - "title": "Full Blog Sample", + "title": "MDX Blog Post", "summary": "HTML Heading 1", "date_modified": "2021-03-05T00:00:00.000Z", "tags": [] @@ -256,7 +256,7 @@ exports[`rss filters to the first two entries 1`] = ` Test MDX with require calls

]]> - <![CDATA[Full Blog Sample]]> + <![CDATA[MDX Blog Post]]> https://docusaurus.io/myBaseUrl/blog/mdx-blog-post https://docusaurus.io/myBaseUrl/blog/mdx-blog-post Fri, 05 Mar 2021 00:00:00 GMT @@ -290,7 +290,7 @@ exports[`rss has feed item for each post 1`] = ` Test MDX with require calls

]]> - <![CDATA[Full Blog Sample]]> + <![CDATA[MDX Blog Post]]> https://docusaurus.io/myBaseUrl/blog/mdx-blog-post https://docusaurus.io/myBaseUrl/blog/mdx-blog-post Fri, 05 Mar 2021 00:00:00 GMT diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts index ee7c68680c..14f0394c25 100644 --- a/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts +++ b/packages/docusaurus-plugin-content-blog/src/__tests__/index.test.ts @@ -175,6 +175,33 @@ describe('blog plugin', () => { unlisted: false, }); + expect(getByTitle(blogPosts, 'MDX Blog Post').metadata).toEqual({ + authors: [], + date: new Date('2021-03-05T00:00:00.000Z'), + description: 'HTML Heading 1', + editUrl: 'https://baseEditUrl.com/edit/blog/mdx-blog-post.mdx', + formattedDate: 'March 5, 2021', + frontMatter: { + date: new Date('2021-03-05T00:00:00.000Z'), + title: 'MDX Blog Post', + }, + hasTruncateMarker: true, + nextItem: { + permalink: '/blog/hey/my super path/héllô', + title: 'Complex Slug', + }, + permalink: '/blog/mdx-blog-post', + prevItem: { + permalink: '/blog/mdx-require-blog-post', + title: 'MDX Blog Sample with require calls', + }, + readingTime: 0.26, + source: '@site/blog/mdx-blog-post.mdx', + tags: [], + title: 'MDX Blog Post', + unlisted: false, + }); + expect( getByTitle(blogPosts, 'Happy 1st Birthday Slash! (translated)').metadata, ).toEqual({ diff --git a/packages/docusaurus-plugin-content-blog/src/options.ts b/packages/docusaurus-plugin-content-blog/src/options.ts index 0ee9e50f8f..5d136d4399 100644 --- a/packages/docusaurus-plugin-content-blog/src/options.ts +++ b/packages/docusaurus-plugin-content-blog/src/options.ts @@ -26,7 +26,7 @@ export const DEFAULT_OPTIONS: PluginOptions = { beforeDefaultRehypePlugins: [], beforeDefaultRemarkPlugins: [], admonitions: true, - truncateMarker: //, + truncateMarker: /|\{\/\*\s*truncate\s*\*\/\}/, rehypePlugins: [], remarkPlugins: [], showReadingTime: true, diff --git a/website/blog/2017-12-14-introducing-docusaurus.mdx b/website/blog/2017-12-14-introducing-docusaurus.mdx index 84ed69c402..741a56821c 100644 --- a/website/blog/2017-12-14-introducing-docusaurus.mdx +++ b/website/blog/2017-12-14-introducing-docusaurus.mdx @@ -15,7 +15,7 @@ We created [Docusaurus](https://docusaurus.io) for the following reasons: 1. To make it easy to push updates, new features, and bug fixes to everyone all at once. 1. And, finally, to provide a consistent look and feel across all of our open source projects. - +{/* truncate */} Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. At its core, all a user has to provide are documentation files written in Markdown, customization of a provided home page written in React, and a few configuration modifications. Docusaurus handles the rest by providing default styles, site formatting, and simple document navigation. Getting started is easy, as users can [install](https://v1.docusaurus.io/docs/en/installation.html) it using `npm` or `yarn` via a simple initialization script that [creates a working example website out of the box](https://v1.docusaurus.io/docs/en/site-preparation.html). diff --git a/website/blog/2018-04-30-How-I-Converted-Profilo-To-Docusaurus.mdx b/website/blog/2018-04-30-How-I-Converted-Profilo-To-Docusaurus.mdx index bd2fa2e404..910c13bb2d 100644 --- a/website/blog/2018-04-30-How-I-Converted-Profilo-To-Docusaurus.mdx +++ b/website/blog/2018-04-30-How-I-Converted-Profilo-To-Docusaurus.mdx @@ -15,7 +15,7 @@ This is the story of the rather short journey it took to create the [Profilo](ht Profilo, an Android library for collecting performance traces from production, [was announced](https://code.fb.com/android/profilo-understanding-app-performance-in-the-wild/) earlier this year. The project was [published on GitHub](https://github.com/facebookincubator/profilo/tree/802042f90f990998a272387e371b893af52465b8) with a less than [a handful or Markdown files](https://github.com/facebookincubator/profilo/tree/802042f90f990998a272387e371b893af52465b8/docs) to describe its functionality and no website to showcase any branding and highlight the logo. The task at hand was to turn these existing docs and logo into a website. - +{/* truncate */} In general, when creating a website with Docusaurus you do the following: diff --git a/website/blog/2018-09-11-Towards-Docusaurus-2.mdx b/website/blog/2018-09-11-Towards-Docusaurus-2.mdx index 0cf963c66b..2f008340a2 100644 --- a/website/blog/2018-09-11-Towards-Docusaurus-2.mdx +++ b/website/blog/2018-09-11-Towards-Docusaurus-2.mdx @@ -12,7 +12,7 @@ Docusaurus was [officially announced](https://v1.docusaurus.io/blog/2017/12/14/i There is a saying that the very best software is constantly evolving, and the very worst is not. In case you are not aware, we have been planning and working on the next version of Docusaurus 🎉. - +{/* truncate */} ## Introduction diff --git a/website/blog/2018-12-14-Happy-First-Birthday-Slash.mdx b/website/blog/2018-12-14-Happy-First-Birthday-Slash.mdx index 063daac221..ab12327c89 100644 --- a/website/blog/2018-12-14-Happy-First-Birthday-Slash.mdx +++ b/website/blog/2018-12-14-Happy-First-Birthday-Slash.mdx @@ -10,7 +10,7 @@ tags: [birth] Docusaurus [went live](https://v1.docusaurus.io/blog/2017/12/14/introducing-docusaurus) on December 14, 2017. At the time, we had [8 early adopters](https://v1.docusaurus.io/blog/2017/12/14/introducing-docusaurus#acknowledgements). - +{/* truncate */} We now have nearly [60 known users of Docusaurus](https://v1.docusaurus.io/en/users), and probably more that we don't know about. We have [9K GitHub stars](https://github.com/facebook/docusaurus) and an active community, particularly [Yangshun Tay](https://twitter.com/yangshunz) and [Endilie Yacop Sucipto](https://twitter.com/endiliey), both of whom are the lead maintainers helping keep this project [moving forward](https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2). diff --git a/website/blog/2019-12-30-docusaurus-2019-recap.mdx b/website/blog/2019-12-30-docusaurus-2019-recap.mdx index 709f28702c..99ac23c18d 100644 --- a/website/blog/2019-12-30-docusaurus-2019-recap.mdx +++ b/website/blog/2019-12-30-docusaurus-2019-recap.mdx @@ -6,7 +6,7 @@ tags: [recap] 2019 was a great year for Docusaurus - we've made tremendous progress on [Docusaurus 2](https://docusaurus.io/). Current Docusaurus 1 users who aren't using the translations feature can feel free to check it out and [migrate](https://docusaurus.io/docs/migration) to it! Otherwise we will work with you to make that happen in 2020 :) - +{/* truncate */} ## Docusaurus 2 (D2) diff --git a/website/blog/2020-01-07-tribute-to-endi.mdx b/website/blog/2020-01-07-tribute-to-endi.mdx index ac09cf8d34..89fbb52f84 100644 --- a/website/blog/2020-01-07-tribute-to-endi.mdx +++ b/website/blog/2020-01-07-tribute-to-endi.mdx @@ -6,7 +6,7 @@ tags: [endi, tribute] It is with great sadness to announce that our primary external Docusaurus contributor, [Endilie Yacop Sucipto](https://github.com/endiliey) (Endi to those who knew him), [passed away](https://give.asia/campaign/help_endi_beat_cancer#/updates) over the weekend after an illness associated with his bout with cancer. - +{/* truncate */} It is impossible to overstate Endi's impact on this project: diff --git a/website/blog/2021-01-19-docusaurus-2020-recap.mdx b/website/blog/2021-01-19-docusaurus-2020-recap.mdx index 814fa20f17..d7bfad69e7 100644 --- a/website/blog/2021-01-19-docusaurus-2020-recap.mdx +++ b/website/blog/2021-01-19-docusaurus-2020-recap.mdx @@ -15,7 +15,7 @@ We are **still in alpha**, but expect **some good news very soon**! ![Three Docusaurus plushies laid side-by-side on the table](/img/blog/2020-recap/docusaurus-plushie-banner.jpeg) - +{/* truncate */} ## Docusaurus 2 highlights diff --git a/website/blog/2021-03-09-releasing-docusaurus-i18n.mdx b/website/blog/2021-03-09-releasing-docusaurus-i18n.mdx index 87cb8117c3..3d83cb9d40 100644 --- a/website/blog/2021-03-09-releasing-docusaurus-i18n.mdx +++ b/website/blog/2021-03-09-releasing-docusaurus-i18n.mdx @@ -15,7 +15,7 @@ In this post, we will present you the **translation workflow**, explain some **d We also **dogfood** the i18n support on the **Docusaurus 2 site itself**, and this post is already available in [English](https://docusaurus.io/blog/2021/03/09/releasing-docusaurus-i18n) and [French](https://docusaurus.io/fr/blog/2021/03/09/releasing-docusaurus-i18n)! - +{/* truncate */} ## Translate your site diff --git a/website/blog/2021-05-12-announcing-docusaurus-two-beta/index.mdx b/website/blog/2021-05-12-announcing-docusaurus-two-beta/index.mdx index 4998272633..fe6f169422 100644 --- a/website/blog/2021-05-12-announcing-docusaurus-two-beta/index.mdx +++ b/website/blog/2021-05-12-announcing-docusaurus-two-beta/index.mdx @@ -17,7 +17,7 @@ With the announcement of this beta, the team is even more confident that Docusau ![](./img/image_cropped.png) - +{/* truncate */} ## Docusaurus adoption diff --git a/website/blog/2021-11-21-algolia-docsearch-migration/index.mdx b/website/blog/2021-11-21-algolia-docsearch-migration/index.mdx index 583054e541..2dd0499b46 100644 --- a/website/blog/2021-11-21-algolia-docsearch-migration/index.mdx +++ b/website/blog/2021-11-21-algolia-docsearch-migration/index.mdx @@ -16,7 +16,7 @@ image: ./img/social-card.png Docusaurus site owners should upgrade their configuration with [their new credentials](#im-using-docusaurus-and-docsearch-can-i-migrate) **by February 1, 2022**, existing search indexes will be frozen and become read-only after this date. - +{/* truncate */} ## Upgrading your Docusaurus site diff --git a/website/blog/2022-01-24-docusaurus-2021-recap/index.mdx b/website/blog/2022-01-24-docusaurus-2021-recap/index.mdx index 7a7863c63d..e1f1e75269 100644 --- a/website/blog/2022-01-24-docusaurus-2021-recap/index.mdx +++ b/website/blog/2022-01-24-docusaurus-2021-recap/index.mdx @@ -13,7 +13,7 @@ The **official v2 release** is just around the corner! Follow the [roadmap issue ![](./img/thumbnail.png) - +{/* truncate */} ## Highlights diff --git a/website/blog/2022-09-01-docusaurus-2.1/index.mdx b/website/blog/2022-09-01-docusaurus-2.1/index.mdx index 6ccb1ea7d6..8e816aedcf 100644 --- a/website/blog/2022-09-01-docusaurus-2.1/index.mdx +++ b/website/blog/2022-09-01-docusaurus-2.1/index.mdx @@ -12,7 +12,7 @@ The upgrade should be easy: as explained in our [release process documentation]( ![Docusaurus 2.1 social card](./img/social-card.png) - +{/* truncate */} ## Highlights