Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(v2): fixed typos #4479

Merged
merged 1 commit into from
Mar 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-migrate/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-migrate/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
idontknowjs marked this conversation as resolved.
Show resolved Hide resolved
Frequent broken links are linking to:
- ./myBrokenLinkFrequent1
- ./myBrokenLinkFrequent2

Expand Down
4 changes: 2 additions & 2 deletions packages/docusaurus/src/server/brokenLinks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)
Expand Down
2 changes: 1 addition & 1 deletion website-1.x/docs/api-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website-1.x/versioned_docs/version-1.10.x/api-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website-1.x/versioned_docs/version-1.9.x/api-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website/community/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/migration/migration-automated.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

:::

Expand Down
2 changes: 1 addition & 1 deletion website/docs/migration/migration-translated-sites.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-2.0.0-alpha.71/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-2.0.0-alpha.72/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down