Skip to content

Commit 02eee61

Browse files
forresstlex111
forresst
and
lex111
authored
docs: improve escape pipe in Markdown tables (facebook#5539)
* Test escape pipe in Markdown table From a remark on Crowdin: > The value for the Type entry in the plugin-content-blog page is strange. > In English documents, the Type item value is normally displayed. > ex) editUrl: string | EditUrlFunction > However, in French documentation, the Type item value is shown as an unknown code. > ex) editUrl:!!crwdBlockTags_249_sgaTkcolBdwrc!! > ex) blogSidebarCount: !!crwdBlockTags_250_sgaTkcolBdwrc!! This is a test to see if the other way to escape a pipe in a markdown table could solve the problem. * Fix all docs to replace &facebook#124; by \| * Keep `code` * Apply suggestions from code review Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
1 parent ac2b0f7 commit 02eee61

File tree

9 files changed

+51
-51
lines changed

9 files changed

+51
-51
lines changed

‎website/docs/api/plugins/plugin-content-blog.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ Accepted fields:
2929
| Name | Type | Default | Description |
3030
| --- | --- | --- | --- |
3131
| `path` | `string` | `'blog'` | Path to the blog content directory on the filesystem, relative to site dir. |
32-
| `editUrl` | <code>string &#124; EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
32+
| `editUrl` | <code>string \| EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
3333
| `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. |
3434
| `blogTitle` | `string` | `'Blog'` | Blog page title for better SEO. |
3535
| `blogDescription` | `string` | `'Blog'` | Blog page meta description for better SEO. |
36-
| `blogSidebarCount` | <code>number &#124; 'ALL'</code> | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable |
36+
| `blogSidebarCount` | <code>number \| 'ALL'</code> | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable |
3737
| `blogSidebarTitle` | `string` | `'Recent posts'` | Title of the blog sidebar. |
3838
| `routeBasePath` | `string` | `'blog'` | URL route for the blog section of your site. **DO NOT** include a trailing slash. Use `/` to put the blog at root path. |
3939
| `archiveBasePath` | `string` | `'/archive'` | URL route for the archive blog section of your site. It is prepended to the `routeBasePath`. **DO NOT** include a trailing slash. |
4040
| `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. |
4141
| `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. |
42-
| `postsPerPage` | <code>number &#124; 'ALL'</code> | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. |
42+
| `postsPerPage` | <code>number \| 'ALL'</code> | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. |
4343
| `blogListComponent` | `string` | `'@theme/BlogListPage'` | Root component of the blog listing page. |
4444
| `blogPostComponent` | `string` | `'@theme/BlogPostPage'` | Root component of each blog post page. |
4545
| `blogTagsListComponent` | `string` | `'@theme/BlogTagsListPage'` | Root component of the tags list page |
@@ -52,7 +52,7 @@ Accepted fields:
5252
| `showReadingTime` | `boolean` | `true` | Show estimated reading time for the blog post. |
5353
| `authorsMapPath` | `string` | `'authors.yml'` | Path to the authors map file, relative to the blog content directory specified with `path`. Can also be a `json` file. |
5454
| `feedOptions` | _See below_ | `{type: ['rss', 'atom']}` | Blog feed. If undefined, no rss feed will be generated. |
55-
| `feedOptions.type` | <code>'rss' &#124; 'atom' &#124; 'all'</code> (or array of multiple options) | **Required** | Type of feed to be generated. |
55+
| `feedOptions.type` | <code>'rss' \| 'atom' \| 'all'</code> (or array of multiple options) | **Required** | Type of feed to be generated. |
5656
| `feedOptions.title` | `string` | `siteConfig.title` | Title of the feed. |
5757
| `feedOptions.description` | `string` | <code>\`${siteConfig.title} Blog\`</code> | Description of the feed. |
5858
| `feedOptions.copyright` | `string` | `undefined` | Copyright message. |

‎website/docs/api/plugins/plugin-content-docs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ Accepted fields:
2929
| Name | Type | Default | Description |
3030
| --- | --- | --- | --- |
3131
| `path` | `string` | `'docs'` | Path to data on filesystem relative to site dir. |
32-
| `editUrl` | <code>string &#124; EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
32+
| `editUrl` | <code>string \| EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
3333
| `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. |
3434
| `editCurrentVersion` | `boolean` | `false` | The edit URL will always target the current version doc instead of older versions. Ignored when `editUrl` is a function. |
3535
| `routeBasePath` | `string` | `'docs'` | URL route for the docs section of your site. **DO NOT** include a trailing slash. Use `/` for shipping docs without base path. |
3636
| `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. |
3737
| `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. |
38-
| `sidebarPath` | <code>false &#124; string</code> | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. |
38+
| `sidebarPath` | <code>false \| string</code> | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. |
3939
| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. See also [Collapsible categories](/docs/sidebar#collapsible-categories) |
4040
| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. See also [Expanded categories by default](/docs/sidebar#expanded-categories-by-default) |
4141
| `sidebarItemsGenerator` | `SidebarGenerator` | _Omitted_ | Function used to replace the sidebar items of type `'autogenerated'` by real sidebar items (docs, categories, links...). See also [Customize the sidebar items generator](/docs/sidebar#customize-the-sidebar-items-generator) |
42-
| `numberPrefixParser` | <code>boolean &#124; PrefixParser</code> | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar#using-number-prefixes) |
42+
| `numberPrefixParser` | <code>boolean \| PrefixParser</code> | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar#using-number-prefixes) |
4343
| `docLayoutComponent` | `string` | `'@theme/DocPage'` | Root Layout component of each doc page. |
4444
| `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. |
4545
| `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page |

‎website/docs/api/themes/theme-configuration.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Accepted fields:
2020

2121
| Name | Type | Default | Description |
2222
| --- | --- | --- | --- |
23-
| `defaultMode` | <code>'light' &#124; 'dark' </code> | `'light'` | The color mode when user first visits the site. |
23+
| `defaultMode` | <code>'light' \| 'dark'</code> | `'light'` | The color mode when user first visits the site. |
2424
| `disableSwitch` | `boolean` | `false` | Hides the switch in the navbar. Useful if you want to support a single color mode. |
2525
| `respectPrefersColorScheme` | `boolean` | `false` | Whether to use the `prefers-color-scheme` media-query, using user system preferences, instead of the hardcoded `defaultMode`. |
2626
| `switchConfig` | _See below_ | _See below_ | Dark/light switch icon options. |
@@ -166,7 +166,7 @@ Accepted fields:
166166
| `logo` | _See below_ | `undefined` | Customization of the logo object. |
167167
| `items` | `NavbarItem[]` | `[]` | A list of navbar items. See specification below. |
168168
| `hideOnScroll` | `boolean` | `false` | Whether the navbar is hidden when the user scrolls down. |
169-
| `style` | <code>'primary' &#124; 'dark' </code> | Same as theme | Sets the navbar style, ignoring the dark/light theme. |
169+
| `style` | <code>'primary' \| 'dark'</code> | Same as theme | Sets the navbar style, ignoring the dark/light theme. |
170170

171171
</small>
172172

@@ -269,7 +269,7 @@ Accepted fields:
269269
| `to` | `string` | **Required** | Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value. |
270270
| `href` | `string` | **Required** | A full-page navigation, used for navigating outside of the website. **Only one of `to` or `href` should be used.** |
271271
| `prependBaseUrlToHref` | `boolean` | `false` | Prepends the baseUrl to `href` values. |
272-
| `position` | <code>'left' &#124; 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
272+
| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
273273
| `activeBasePath` | `string` | `to` / `href` | To apply the active class styling on all routes starting with this path. This usually isn't necessary. |
274274
| `activeBaseRegex` | `string` | `undefined` | Alternative to `activeBasePath` if required. |
275275
| `className` | `string` | `''` | Custom CSS class (for styling any item). |
@@ -326,7 +326,7 @@ Accepted fields:
326326
| --- | --- | --- | --- |
327327
| `label` | `string` | **Required** | The name to be shown for this item. |
328328
| `items` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | **Required** | The items to be contained in the dropdown. |
329-
| `position` | <code>'left' &#124; 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
329+
| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
330330

331331
</small>
332332

@@ -374,7 +374,7 @@ Accepted fields:
374374
| --- | --- | --- | --- |
375375
| `docId` | `string` | **Required** | The ID of the doc that this item links to. |
376376
| `label` | `string` | `docId` | The name to be shown for this item. |
377-
| `position` | <code>'left' &#124; 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
377+
| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
378378
| `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc belongs to. |
379379

380380
</small>
@@ -412,7 +412,7 @@ Accepted fields:
412412

413413
| Name | Type | Default | Description |
414414
| --- | --- | --- | --- |
415-
| `position` | <code>'left' &#124; 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
415+
| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
416416
| `dropdownItemsBefore` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the beginning of the dropdown. |
417417
| `dropdownItemsAfter` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the end of the dropdown. |
418418
| `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. |
@@ -453,7 +453,7 @@ Accepted fields:
453453
| --- | --- | --- | --- |
454454
| `label` | `string` | The active/latest version label. | The name to be shown for this item. |
455455
| `to` | `string` | The active/latest version. | The internal link that this item points to. |
456-
| `position` | <code>'left' &#124; 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
456+
| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
457457
| `docsPluginId` | `string` | `'default'` | The ID of the docs plugin that the doc versioning belongs to. |
458458

459459
</small>
@@ -491,7 +491,7 @@ Accepted fields:
491491

492492
| Name | Type | Default | Description |
493493
| --- | --- | --- | --- |
494-
| `position` | <code>'left' &#124; 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
494+
| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
495495
| `dropdownItemsBefore` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the beginning of the dropdown. |
496496
| `dropdownItemsAfter` | <code>[LinkLikeItem](#navbar-dropdown)[]</code> | `[]` | Add additional dropdown items at the end of the dropdown. |
497497

@@ -532,7 +532,7 @@ However, with this special navbar item type, you can change the default location
532532

533533
| Name | Type | Default | Description |
534534
| --- | --- | --- | --- |
535-
| `position` | <code>'left' &#124; 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
535+
| `position` | <code>'left' \| 'right'</code> | `'left'` | The side of the navbar this item should appear on. |
536536

537537
</small>
538538

@@ -655,7 +655,7 @@ Accepted fields:
655655
| --- | --- | --- | --- |
656656
| `logo` | `Logo` | `undefined` | Customization of the logo object. See [Navbar logo](#navbar-logo) for details. |
657657
| `copyright` | `string` | `undefined` | The copyright message to be displayed at the bottom. |
658-
| `style` | <code>'dark' &#124; 'light'</code> | `'light'` | The color theme of the footer component. |
658+
| `style` | <code>'dark' \| 'light'</code> | `'light'` | The color theme of the footer component. |
659659
| `items` | `FooterItem[]` | `[]` | The link groups to be present. |
660660

661661
</small>

‎website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-blog.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ Accepted fields:
2929
| Name | Type | Default | Description |
3030
| --- | --- | --- | --- |
3131
| `path` | `string` | `'blog'` | Path to the blog content directory on the filesystem, relative to site dir. |
32-
| `editUrl` | <code>string &#124; EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
32+
| `editUrl` | <code>string \| EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
3333
| `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. |
3434
| `blogTitle` | `string` | `'Blog'` | Blog page title for better SEO. |
3535
| `blogDescription` | `string` | `'Blog'` | Blog page meta description for better SEO. |
36-
| `blogSidebarCount` | <code>number &#124; 'ALL'</code> | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable |
36+
| `blogSidebarCount` | <code>number \| 'ALL'</code> | `5` | Number of blog post elements to show in the blog sidebar. `'ALL'` to show all blog posts; `0` to disable |
3737
| `blogSidebarTitle` | `string` | `'Recent posts'` | Title of the blog sidebar. |
3838
| `routeBasePath` | `string` | `'blog'` | URL route for the blog section of your site. **DO NOT** include a trailing slash. Use `/` to put the blog at root path. |
3939
| `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. |
4040
| `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. |
41-
| `postsPerPage` | <code>number &#124; 'ALL'</code> | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. |
41+
| `postsPerPage` | <code>number \| 'ALL'</code> | `10` | Number of posts to show per page in the listing page. Use `'ALL'` to display all posts on one listing page. |
4242
| `blogListComponent` | `string` | `'@theme/BlogListPage'` | Root component of the blog listing page. |
4343
| `blogPostComponent` | `string` | `'@theme/BlogPostPage'` | Root component of each blog post page. |
4444
| `blogTagsListComponent` | `string` | `'@theme/BlogTagsListPage'` | Root component of the tags list page |
@@ -51,7 +51,7 @@ Accepted fields:
5151
| `showReadingTime` | `boolean` | `true` | Show estimated reading time for the blog post. |
5252
| `authorsMapPath` | `string` | `'authors.yml'` | Path to the authors map file, relative to the blog content directory specified with `path`. Can also be a `json` file. |
5353
| `feedOptions` | _See below_ | `{type: ['rss', 'atom']}` | Blog feed. If undefined, no rss feed will be generated. |
54-
| `feedOptions.type` | <code>'rss' &#124; 'atom' &#124; 'all'</code> (or array of multiple options) | **Required** | Type of feed to be generated. |
54+
| `feedOptions.type` | <code>'rss' \| 'atom' \| 'all'</code> (or array of multiple options) | **Required** | Type of feed to be generated. |
5555
| `feedOptions.title` | `string` | `siteConfig.title` | Title of the feed. |
5656
| `feedOptions.description` | `string` | <code>\`${siteConfig.title} Blog\`</code> | Description of the feed. |
5757
| `feedOptions.copyright` | `string` | `undefined` | Copyright message. |

‎website/versioned_docs/version-2.0.0-beta.5/api/plugins/plugin-content-docs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ Accepted fields:
2929
| Name | Type | Default | Description |
3030
| --- | --- | --- | --- |
3131
| `path` | `string` | `'docs'` | Path to data on filesystem relative to site dir. |
32-
| `editUrl` | <code>string &#124; EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
32+
| `editUrl` | <code>string \| EditUrlFunction</code> | `undefined` | Base URL to edit your site. The final URL is computed by `editUrl + relativeDocPath`. Using a function allows more nuanced control for each file. Omitting this variable entirely will disable edit links. |
3333
| `editLocalizedFiles` | `boolean` | `false` | The edit URL will target the localized file, instead of the original unlocalized file. Ignored when `editUrl` is a function. |
3434
| `editCurrentVersion` | `boolean` | `false` | The edit URL will always target the current version doc instead of older versions. Ignored when `editUrl` is a function. |
3535
| `routeBasePath` | `string` | `'docs'` | URL route for the docs section of your site. **DO NOT** include a trailing slash. Use `/` for shipping docs without base path. |
3636
| `include` | `string[]` | `['**/*.{md,mdx}']` | Matching files will be included and processed. |
3737
| `exclude` | `string[]` | _See example configuration_ | No route will be created for matching files. |
38-
| `sidebarPath` | <code>false &#124; string</code> | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. |
38+
| `sidebarPath` | <code>false \| string</code> | `undefined` (creates autogenerated sidebar) | Path to sidebar configuration. |
3939
| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. See also [Collapsible categories](/docs/sidebar#collapsible-categories) |
4040
| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. See also [Expanded categories by default](/docs/sidebar#expanded-categories-by-default) |
4141
| `sidebarItemsGenerator` | `SidebarGenerator` | _Omitted_ | Function used to replace the sidebar items of type `'autogenerated'` by real sidebar items (docs, categories, links...). See also [Customize the sidebar items generator](/docs/sidebar#customize-the-sidebar-items-generator) |
42-
| `numberPrefixParser` | <code>boolean &#124; PrefixParser</code> | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar#using-number-prefixes) |
42+
| `numberPrefixParser` | <code>boolean \| PrefixParser</code> | _Omitted_ | Custom parsing logic to extract number prefixes from file names. Use `false` to disable this behavior and leave the docs untouched, and `true` to use the default parser. See also [Using number prefixes](/docs/sidebar#using-number-prefixes) |
4343
| `docLayoutComponent` | `string` | `'@theme/DocPage'` | Root Layout component of each doc page. |
4444
| `docItemComponent` | `string` | `'@theme/DocItem'` | Main doc container, with TOC, pagination, etc. |
4545
| `docTagsListComponent` | `string` | `'@theme/DocTagsListPage'` | Root component of the tags list page |

0 commit comments

Comments
 (0)