3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 16:59:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2, v1): fixed typos (#4479)

Browse source
This commit is contained in:
Arijit Kundu 2021-03-22 22:30:32 +05:30 • committed by GitHub
parent 3c165c3b89
commit af840b7f85
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -1112,7 +1112,7 @@ N/A
## [1.0.10] - 2018-04-09
This is a general release with mostly bug fixes and documentation updates (which are already live on docusuarus.io).
This is a general release with mostly bug fixes and documentation updates (which are already live on docusaurus.io).
### Breaking Changes
@ -1287,7 +1287,7 @@ This is generally a bug fix release, with some code refactoring. Total commits i
- Links on landing page in `docusaurus-init` test site do not 404 any longer.
- Refactoring how we check for translations and versioning (PRs #322/#316 and friends).
- Refactored the example `index.js` page (PR #293).
- Link errors, typos and grammatical errors in the docusuarus.io documentation.
- Link errors, typos and grammatical errors in the docusaurus.io documentation.
### Removed

2
packages/docusaurus-migrate/README.md
View file

@ -1,6 +1,6 @@
# `@docusaurus/migrate`
A CLI tool to migrate from older versions of Docusuarus.
A CLI tool to migrate from older versions of Docusaurus.
## Usage

2
packages/docusaurus-migrate/package.json
View file

@ -1,7 +1,7 @@
{
"name": "@docusaurus/migrate",
"version": "2.0.0-alpha.72",
"description": "A CLI tool to migrate from older versions of Docusuarus.",
"description": "A CLI tool to migrate from older versions of Docusaurus.",
"main": "lib/index.js",
"license": "MIT",
"engines": {

6
packages/docusaurus/src/server/__tests__/__snapshots__/brokenLinks.test.ts.snap
View file

@ -3,7 +3,7 @@
exports[`brokenLinks getBrokenLinksErrorMessage 1`] = `
"Docusaurus found broken links!
Please check the pages of your site in the list bellow, and make sure you don't reference any path that does not exist.
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken links found:
@ -20,13 +20,13 @@ Exhaustive list of all broken links found:
exports[`brokenLinks getBrokenLinksErrorMessage with potential layout broken links 1`] = `
"Docusaurus found broken links!
Please check the pages of your site in the list bellow, and make sure you don't reference any path that does not exist.
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
It looks like some of the broken links we found appear in many pages of your site.
Maybe those broken links appear on all pages through your site layout?
We recommend that you check your theme configuration for such links (particularly, theme navbar and footer).
Frequent broken links are linking to:
Frequent broken links are linking to:
- ./myBrokenLinkFrequent1
- ./myBrokenLinkFrequent2

4
packages/docusaurus/src/server/brokenLinks.ts
View file

@ -130,13 +130,13 @@ export function getBrokenLinksErrorMessage(
return '';
}
return `\n\nIt looks like some of the broken links we found appear in many pages of your site.\nMaybe those broken links appear on all pages through your site layout?\nWe recommend that you check your theme configuration for such links (particularly, theme navbar and footer).\nFrequent broken links are linking to: \n- ${frequentLinks.join(
return `\n\nIt looks like some of the broken links we found appear in many pages of your site.\nMaybe those broken links appear on all pages through your site layout?\nWe recommend that you check your theme configuration for such links (particularly, theme navbar and footer).\nFrequent broken links are linking to:\n- ${frequentLinks.join(
`\n- `,
)}\n`;
}
return (
`Docusaurus found broken links!\n\nPlease check the pages of your site in the list bellow, and make sure you don't reference any path that does not exist.\nNote: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.${getLayoutBrokenLinksHelpMessage()}` +
`Docusaurus found broken links!\n\nPlease check the pages of your site in the list below, and make sure you don't reference any path that does not exist.\nNote: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.${getLayoutBrokenLinksHelpMessage()}` +
`\n\nExhaustive list of all broken links found:\n${Object.entries(
allBrokenLinks,
)

2
website-1.x/docs/api-pages.md
View file

@ -217,7 +217,7 @@ Static assets should be placed into the `website/static` directory. They can be
You should configure your site's primary, secondary, and code block colors using the `colors` field in `siteConfig` as specified [here](api-site-config.md). You can also configure other colors in the same way as described in the `siteConfig` doc.
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the `docusaurus-init` or `yarn install` command, your default styles can be found at `website/node_modules/docusaurus/lib/static/css/main.css`. Alternatively, the `main.css` file may be inspected directly at the [Docusarus GitHub repository](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/lib/static/css/main.css).
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the `docusaurus-init` or `yarn install` command, your default styles can be found at `website/node_modules/docusaurus/lib/static/css/main.css`. Alternatively, the `main.css` file may be inspected directly at the [Docusaurus GitHub repository](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/lib/static/css/main.css).
You can provide your own custom styles by adding them anywhere in the `website/static` directory. Any `.css` files you provide in the `static` directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

2
website-1.x/versioned_docs/version-1.10.x/api-pages.md
View file

@ -218,7 +218,7 @@ Static assets should be placed into the `website/static` directory. They can be
You should configure your site's primary, secondary, and code block colors using the `colors` field in `siteConfig` as specified [here](api-site-config.md). You can also configure other colors in the same way as described in the `siteConfig` doc.
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the `docusaurus-init` or `yarn install` command, your default styles can be found at `website/node_modules/docusaurus/lib/static/css/main.css`. Alternatively, the `main.css` file may be inspected directly at the [Docusarus GitHub repository](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/lib/static/css/main.css).
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the `docusaurus-init` or `yarn install` command, your default styles can be found at `website/node_modules/docusaurus/lib/static/css/main.css`. Alternatively, the `main.css` file may be inspected directly at the [Docusaurus GitHub repository](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/lib/static/css/main.css).
You can provide your own custom styles by adding them anywhere in the `website/static` directory. Any `.css` files you provide in the `static` directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

2
website-1.x/versioned_docs/version-1.9.x/api-pages.md
View file

@ -218,7 +218,7 @@ Static assets should be placed into the `website/static` directory. They can be
You should configure your site's primary, secondary, and code block colors using the `colors` field in `siteConfig` as specified [here](api-site-config.md). You can also configure other colors in the same way as described in the `siteConfig` doc.
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the `docusaurus-init` or `yarn install` command, your default styles can be found at `website/node_modules/docusaurus/lib/static/css/main.css`. Alternatively, the `main.css` file may be inspected directly at the [Docusarus GitHub repository](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/lib/static/css/main.css).
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the `docusaurus-init` or `yarn install` command, your default styles can be found at `website/node_modules/docusaurus/lib/static/css/main.css`. Alternatively, the `main.css` file may be inspected directly at the [Docusaurus GitHub repository](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/lib/static/css/main.css).
You can provide your own custom styles by adding them anywhere in the `website/static` directory. Any `.css` files you provide in the `static` directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

2
website/community/resources.md
View file

@ -23,7 +23,7 @@ See the <a href={require('@docusaurus/useBaseUrl').default('showcase')}>showcase
### Search {#search}
- [docusaurus-plugin-lunr](https://github.com/daldridge/docusaurus-plugin-lunr) - Docusaurus v2 plugin to create a local search index for use with Lunr.js
- [docusaurus-lunr-search](https://github.com/lelouch77/docusurus-lunr-search) - Offline Search for Docusaurus v2
- [docusaurus-lunr-search](https://github.com/lelouch77/docusaurus-lunr-search) - Offline Search for Docusaurus v2
- [docusaurus-search-local](https://github.com/cmfcmf/docusaurus-search-local) - Offline/local search for Docusaurus v2
- [@easyops-cn/docusaurus-search-local](https://github.com/easyops-cn/docusaurus-search-local) - Offline/local search for Docusaurus v2 (language of zh supported)

2
website/docs/migration/migration-automated.md
View file

@ -46,7 +46,7 @@ yarn start
:::danger
The migration CLI updates existing files. Be sure to have commited them first!
The migration CLI updates existing files. Be sure to have committed them first!
:::

2
website/docs/migration/migration-translated-sites.md
View file

@ -118,7 +118,7 @@ There is no ultimate guide we could write to fix these errors, but common errors
- Not marking enough strings as "hidden strings" in Crowdin, leading to pre-translation trying to translate these strings.
- Having bad v1 translations, leading to invalid markup in v2: bad html elements inside translations and unclosed tags
- Anything rejected by the MDX parser, like using HTML elements instead of JSX elements (use the [MDX plaground](https://mdxjs.com/playground/) for debugging)
- Anything rejected by the MDX parser, like using HTML elements instead of JSX elements (use the [MDX playground](https://mdxjs.com/playground/) for debugging)
You might want to repeat this pre-translation process, eventually trying the "Perfect" option and limiting pre-translation only some languages/files.

2
website/docs/search.md
View file

@ -30,7 +30,7 @@ module.exports = {
apiKey: 'YOUR_API_KEY',
indexName: 'YOUR_INDEX_NAME',
// Optional: see doc section bellow
// Optional: see doc section below
contextualSearch: true,
// Optional: Algolia search parameters

2
website/versioned_docs/version-2.0.0-alpha.71/search.md
View file

@ -30,7 +30,7 @@ module.exports = {
apiKey: 'YOUR_API_KEY',
indexName: 'YOUR_INDEX_NAME',
// Optional: see doc section bellow
// Optional: see doc section below
contextualSearch: true,
// Optional: Algolia search parameters

2
website/versioned_docs/version-2.0.0-alpha.72/search.md
View file

@ -30,7 +30,7 @@ module.exports = {
apiKey: 'YOUR_API_KEY',
indexName: 'YOUR_INDEX_NAME',
// Optional: see doc section bellow
// Optional: see doc section below
contextualSearch: true,
// Optional: Algolia search parameters