Happy 1st Birthday Slash! (translated)
· One min read
Happy birthday! (translated)
Authors
- Docusaurus maintainer (translated)
Happy birthday! (translated)
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
Happy birthday! (translated)
This is a test content.
'; + expect(calculateReadingTime(content)).toBe(0.025); + }); + + it('handles content with markdown', () => { + const content = '# Title\n\nThis is **bold** and *italic* text.'; + expect(calculateReadingTime(content)).toBe(0.04); + }); + + it('handles CJK content', () => { + const content = '你好，世界！这是一段测试内容。'; + expect(calculateReadingTime(content)).toBe(0.06); + }); +}); diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts index ab7426eac5..2cc84bac76 100644 --- a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts +++ b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts @@ -9,7 +9,6 @@ import fs from 'fs-extra'; import path from 'path'; import _ from 'lodash'; import logger from '@docusaurus/logger'; -import readingTime from 'reading-time'; import { parseMarkdownFile, normalizeUrl, @@ -32,6 +31,7 @@ import {getTagsFile} from '@docusaurus/utils-validation'; import {validateBlogPostFrontMatter} from './frontMatter'; import {getBlogPostAuthors} from './authors'; import {reportAuthorsProblems} from './authorsProblems'; +import {calculateReadingTime} from './readingTime'; import type {TagsFile} from '@docusaurus/utils'; import type {LoadContext, ParseFrontMatter} from '@docusaurus/types'; import type { @@ -211,7 +211,7 @@ async function parseBlogPostMarkdownFile({ } const defaultReadingTime: ReadingTimeFunction = ({content, options}) => - readingTime(content, options).minutes; + calculateReadingTime(content, options); async function processBlogSourceFile( blogSourceRelative: string, diff --git a/packages/docusaurus-plugin-content-blog/src/readingTime.ts b/packages/docusaurus-plugin-content-blog/src/readingTime.ts new file mode 100644 index 0000000000..76e4513537 --- /dev/null +++ b/packages/docusaurus-plugin-content-blog/src/readingTime.ts @@ -0,0 +1,29 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +import readingTime from 'reading-time'; + +const DEFAULT_WORDS_PER_MINUTE = 200; + +interface ReadingTimeOptions { + wordsPerMinute?: number; + wordBound?: (char: string) => boolean; +} + +/** + * Calculates the reading time for a given content string. + * Uses the reading-time package under the hood. + */ +export function calculateReadingTime( + content: string, + options: ReadingTimeOptions = {}, +): number { + const wordsPerMinute = options.wordsPerMinute ?? DEFAULT_WORDS_PER_MINUTE; + const {wordBound} = options; + return readingTime(content, {wordsPerMinute, ...(wordBound && {wordBound})}) + .minutes; +} From 5d0df96554d482562db254eb96fb656d5f9c5ec3 Mon Sep 17 00:00:00 2001 From: JiPai <3956400+PaiJi@users.noreply.github.com> Date: Sat, 3 May 2025 01:21:54 +0800 Subject: [PATCH 03/25] docs(deploy): remove `layer0` from deployment docs (#11137) --- website/docs/deployment.mdx | 4 ---- 1 file changed, 4 deletions(-) diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index 1d001e79fe..a7ebeb5052 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -834,10 +834,6 @@ You can deploy your Docusaurus project to [Stormkit](https://www.stormkit.io), a See [docs](https://docs.quantcdn.io/docs/cli/continuous-integration) and [blog](https://www.quantcdn.io/blog) for more examples and use cases for deploying to QuantCDN. -## Deploying to Layer0 {#deploying-to-layer0} - -[Layer0](https://www.layer0.co) is an all-in-one platform to develop, deploy, preview, experiment on, monitor, and run your headless frontend. It is focused on large, dynamic websites and best-in-class performance through EdgeJS (a JavaScript-based Content Delivery Network), predictive prefetching, and performance monitoring. Layer0 offers a free tier. Get started in just a few minutes by following [Layer0's guide to deploying Docusaurus](https://docs.layer0.co/guides/docusaurus). - ## Deploying to Cloudflare Pages {#deploying-to-cloudflare-pages} [Cloudflare Pages](https://pages.cloudflare.com/) is a Jamstack platform for frontend developers to collaborate and deploy websites. Get started within a few minutes by following [this page](https://developers.cloudflare.com/pages/framework-guides/deploy-a-docusaurus-site/). From fef6c4c8cb22a45fa4d3dff016618a3d10fdd552 Mon Sep 17 00:00:00 2001 From: Jack HowardThis is a test content.
'; - expect(calculateReadingTime(content)).toBe(0.025); + expect(calculateReadingTime(content, 'en')).toBe(0.05); }); it('handles content with markdown', () => { const content = '# Title\n\nThis is **bold** and *italic* text.'; - expect(calculateReadingTime(content)).toBe(0.04); + expect(calculateReadingTime(content, 'en')).toBe(0.04); }); it('handles CJK content', () => { const content = '你好，世界！这是一段测试内容。'; - expect(calculateReadingTime(content)).toBe(0.06); + expect(calculateReadingTime(content, 'zh')).toBe(0.04); }); }); diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts index 2cc84bac76..cd3c1b8837 100644 --- a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts +++ b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts @@ -210,8 +210,8 @@ async function parseBlogPostMarkdownFile({ } } -const defaultReadingTime: ReadingTimeFunction = ({content, options}) => - calculateReadingTime(content, options); +const defaultReadingTime: ReadingTimeFunction = ({content, locale, options}) => + calculateReadingTime(content, locale, options); async function processBlogSourceFile( blogSourceRelative: string, @@ -373,6 +373,7 @@ async function processBlogSourceFile( content, frontMatter, defaultReadingTime, + locale: i18n.currentLocale, }) : undefined, hasTruncateMarker: truncateMarker.test(content), diff --git a/packages/docusaurus-plugin-content-blog/src/options.ts b/packages/docusaurus-plugin-content-blog/src/options.ts index 20981aaa87..fe2d64e664 100644 --- a/packages/docusaurus-plugin-content-blog/src/options.ts +++ b/packages/docusaurus-plugin-content-blog/src/options.ts @@ -63,7 +63,8 @@ export const DEFAULT_OPTIONS: PluginOptions = { path: 'blog', editLocalizedFiles: false, authorsMapPath: 'authors.yml', - readingTime: ({content, defaultReadingTime}) => defaultReadingTime({content}), + readingTime: ({content, defaultReadingTime, locale}) => + defaultReadingTime({content, locale}), sortPosts: 'descending', showLastUpdateTime: false, showLastUpdateAuthor: false, diff --git a/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts b/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts index a3056261cf..610fa1052a 100644 --- a/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts +++ b/packages/docusaurus-plugin-content-blog/src/plugin-content-blog.d.ts @@ -387,15 +387,10 @@ declare module '@docusaurus/plugin-content-blog' { }; /** - * Duplicate from ngryman/reading-time to keep stability of API. + * Options for reading time calculation using Intl.Segmenter. */ type ReadingTimeOptions = { wordsPerMinute?: number; - /** - * @param char The character to be matched. - * @returns `true` if this character is a word bound. - */ - wordBound?: (char: string) => boolean; }; /** @@ -405,24 +400,22 @@ declare module '@docusaurus/plugin-content-blog' { export type ReadingTimeFunction = (params: { /** Markdown content. */ content: string; + /** Locale for word segmentation. */ + locale: string; /** Front matter. */ frontMatter?: BlogPostFrontMatter & {[key: string]: unknown}; - /** Options accepted by ngryman/reading-time. */ + /** Options for reading time calculation. */ options?: ReadingTimeOptions; }) => number; /** - * @returns The reading time directly plugged into metadata. `undefined` to - * hide reading time for a specific post. + * @returns The reading time directly plugged into metadata. + * `undefined` to hide reading time for a specific post. */ export type ReadingTimeFunctionOption = ( - /** - * The `options` is not provided by the caller; the user can inject their - * own option values into `defaultReadingTime` - */ params: Required{`docusaurus-v${CurrentMajorVersionNumber}`};
}
-export function NextMajorBranchLink(): ReactNode {
+export function MainBranchLink(): ReactNode {
return | Example | +Normal | +Isolated | +
|---|
| Col1 | +Col2 | +
|---|---|
| Cell1 | +Cell2 | +
| Cell3 | +Cell3 | +
+ This shows how to isolate your components from Docusaurus global + styles. A workaround for{' '} + + this issue + + . +
+