diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 821ba929949f..3a2669ceb880 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -24,7 +24,7 @@ about: Submit a bug report to help us improve (Write what you thought would happen.) @@ -35,7 +35,7 @@ about: Submit a bug report to help us improve Did something go wrong? Is something broken, or not behaving as you expected? Describe this section in detail, and attach screenshots if possible. - Don't just say "it doesn't work"! + Don't only say "it doesn't work"! --> (Write what happened. Add screenshots, if applicable.) diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index 07d7f1a94c51..cafa58a42b03 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -5,7 +5,7 @@ about: Submit a proposal/request for a new feature ## πŸš€ Feature diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md index 218d8d87d92a..044b7d10ddc0 100644 --- a/.github/ISSUE_TEMPLATE/proposal.md +++ b/.github/ISSUE_TEMPLATE/proposal.md @@ -5,7 +5,7 @@ about: Propose a non-trivial change to Docusaurus ## πŸ’₯ Proposal diff --git a/CHANGELOG-2.x.md b/CHANGELOG-2.x.md index 35769ab72700..3f014d03a0ae 100644 --- a/CHANGELOG-2.x.md +++ b/CHANGELOG-2.x.md @@ -69,7 +69,7 @@ ### Features -- Add `` component for easy client side redirect. Example Usage: +- Add `` component for client side redirect. Example Usage: ```js import React from 'react'; import {Redirect} from '@docusaurus/router'; diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71dbde47aa46..16cc0abdfb79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -162,7 +162,7 @@ In order to accept your pull request, we need you to submit a CLA. You only need ### What Happens Next? -The core Docusaurus team will be monitoring for pull requests. Do help us by making your pull request easy to review by following the guidelines above. +The core Docusaurus team will be monitoring for pull requests. Do help us by keeping pull requests consistent by following the guidelines above. ## Style Guide diff --git a/README.md b/README.md index e2b253329606..9c7d1c8b234a 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master ### Beginner Friendly Bugs -To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that contain bugs which are fairly easy to fix. This is a great place to get started. +To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that might contain smaller issues to tackle first. This is a great place to get started. ## Contact diff --git a/admin/extending-remarkable.md b/admin/extending-remarkable.md index 9cd19176d0ca..2149a9896f4f 100644 --- a/admin/extending-remarkable.md +++ b/admin/extending-remarkable.md @@ -20,7 +20,7 @@ Let's talk a bit more about what is done as part of the parsing stage. The resul #### Inline tokens -Inline tokens are simple tokens that have text as a child. They are leaf nodes, and do not support having additional tokens within. An example of this might be `_emphasized text_`, which might be represented as a token of type `em` with contents of `emphasized text`. +Inline tokens are tokens that have text as a child. They are leaf nodes, and do not support having additional tokens within. An example of this might be `_emphasized text_`, which might be represented as a token of type `em` with contents of `emphasized text`. #### Block tokens @@ -36,7 +36,7 @@ The plain markdown text above would be parsed into three tokens: - `text`: Plain text token, with a value of "Hi there". - `heading_close`: Marks the end of the heading. In this case, it would also have a `hLevel: 3` prop. -This is a basic example, because it contains a simple `text` token within the opening and closing tags. A common block encountered in markdown is the paragraph, which might be tokenized into a series of tokens such as `paragraph_open`, one or more `text` tokens, `link` tokens (if links are present within the text, for example), and, eventually, a `paragraph_close` token. +This is a basic example, because it contains a `text` token within the opening and closing tags. A common block encountered in markdown is the paragraph, which might be tokenized into a series of tokens such as `paragraph_open`, one or more `text` tokens, `link` tokens (if links are present within the text, for example), and, eventually, a `paragraph_close` token. #### Core tokens @@ -48,7 +48,7 @@ After we have parsed everything into tokens, we go to the rendering phase. This ## Creating a Remarkable Extension -Now that you have a better idea of how parsing/rendering works, we can proceed to create a simple extension that renders heading anchors. First we need to determine if we need to extend the parser, or the renderer. In this case, we're only interested in changing how a heading is rendered to HTML, so we'll just need to override the heading renderers. +Now that you have a better idea of how parsing/rendering works, we can proceed to create an extension that renders heading anchors. First we need to determine if we need to extend the parser, or the renderer. In this case, we're only interested in changing how a heading is rendered to HTML, so we'll just need to override the heading renderers. The default heading renderers may look like this (you can refer to the Remarkable source code here): diff --git a/docs/api-pages.md b/docs/api-pages.md index 6fb22aafbc5b..5ac76a3384fd 100644 --- a/docs/api-pages.md +++ b/docs/api-pages.md @@ -221,4 +221,4 @@ There are several ways to access the default styles provided for your site. If y 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. -An easy way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. +One way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. diff --git a/docs/api-site-config.md b/docs/api-site-config.md index 859e08ae748b..e3288a47ecee 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -27,7 +27,7 @@ Color configurations for the site. - `primaryColor` is the color used the header navigation bar and sidebars. - `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). -- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to easily configure this color. +- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to configure this color. #### `copyright` [string] diff --git a/docs/getting-started-installation.md b/docs/getting-started-installation.md index 8d6aedac5eb1..fef732b4e350 100644 --- a/docs/getting-started-installation.md +++ b/docs/getting-started-installation.md @@ -8,7 +8,7 @@ Docusaurus was designed from the ground up to be easily installed and used to ge ## Installing Docusaurus -We have created an easy script that will get all of the infrastructure set up for you: +We have created a helpful script that will get all of the infrastructure set up for you: 1. Ensure you have the latest version of [Node](https://nodejs.org/en/download/) installed. We also recommend you install [Yarn](https://yarnpkg.com/en/docs/install) as well. diff --git a/docs/getting-started-publishing.md b/docs/getting-started-publishing.md index 9ad308c983c4..e14d83933195 100644 --- a/docs/getting-started-publishing.md +++ b/docs/getting-started-publishing.md @@ -194,7 +194,7 @@ Now, whenever a new commit lands in `master`, CircleCI will run your suite of te When initially deploying to a `gh-pages` branch using CircleCI, you may notice that some jobs triggered by commits to the `gh-pages` branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications). -You can work around this easily by: +You can work around this by: - Setting the environment variable `CUSTOM_COMMIT_MESSAGE` flag to the `publish-gh-pages` command with the contents of `[skip ci]`. e.g. ```bash @@ -247,7 +247,7 @@ Now, whenever a new commit lands in `master`, Travis CI will run your suite of t ### Hosting on ZEIT Now -With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. +With [ZEIT Now](#using-zeit-now), you can deploy your site and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. ### Hosting on Netlify diff --git a/docs/getting-started-site-creation.md b/docs/getting-started-site-creation.md index 3ee5ccad9264..9c60aee26e29 100644 --- a/docs/getting-started-site-creation.md +++ b/docs/getting-started-site-creation.md @@ -35,7 +35,7 @@ All of your documentation files should be placed inside the `docs` directory as To create a fully functional site, you only need to do a few steps: -1. Add your documentation to the `/docs` directory as `.md` files, ensuring you have the proper [header](api-doc-markdown.md#documents) in each file. The simplest header would be the following, where `id` is the link name (e.g., `docs/intro.html`) and the `title` is the webpage's title. +1. Add your documentation to the `/docs` directory as `.md` files, ensuring you have the proper [header](api-doc-markdown.md#documents) in each file. One example header would be the following, where `id` is the link name (e.g., `docs/intro.html`) and the `title` is the webpage's title. ```yaml --- diff --git a/docs/guides-blog.md b/docs/guides-blog.md index 4c53d3641e29..f96e2c8bd718 100644 --- a/docs/guides-blog.md +++ b/docs/guides-blog.md @@ -94,7 +94,7 @@ blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' }, ## RSS Feed -Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically added to your website page's HTML `` tag. +Docusaurus provides an RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically added to your website page's HTML `` tag. A summary of the post's text is provided in the RSS feed up to the ``. If no `` tag is found, then all text up to 250 characters is used. diff --git a/docs/guides-custom-pages.md b/docs/guides-custom-pages.md index 49c0d6d9344b..450f914b58bd 100644 --- a/docs/guides-custom-pages.md +++ b/docs/guides-custom-pages.md @@ -13,7 +13,7 @@ You can [start](getting-started-preparation.md#verifying-installation) your loca ## Adding Other Custom Pages -Docusaurus provides some simple example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. +Docusaurus provides some helpful example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. ```bash root-directory @@ -33,7 +33,7 @@ root-directory └── static ``` -Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). +You are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). > If you want your page to show up in your navigation header, you will need to update `siteConfig.js` to add to the `headerLinks` element. e.g., `{ page: 'about-slash', label: 'About/' }`, diff --git a/docs/guides-navigation.md b/docs/guides-navigation.md index 28f75240d7ee..bcd4524c33ee 100644 --- a/docs/guides-navigation.md +++ b/docs/guides-navigation.md @@ -262,7 +262,7 @@ These are two separate class names so you can have the active styles applied to ## Secondary On-Page Navigation -We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`. +We support secondary on-page navigation so you can quickly see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`. ```js { diff --git a/docs/guides-translation.md b/docs/guides-translation.md index 27b24baafaa7..cc02b80e64dc 100644 --- a/docs/guides-translation.md +++ b/docs/guides-translation.md @@ -3,7 +3,7 @@ id: translation title: Translations & Localization --- -Docusaurus allows for easy translation functionality using [Crowdin](https://crowdin.com/). Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a `` tag. Other titles and labels will also be found and properly translated. +Docusaurus allows for useful translation functionality using [Crowdin](https://crowdin.com/). Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a `` tag. Other titles and labels will also be found and properly translated. ## Docusaurus Translation Configurations diff --git a/packages/docusaurus-1.x/README.md b/packages/docusaurus-1.x/README.md index a0f64bedee09..ba41fa3020ef 100644 --- a/packages/docusaurus-1.x/README.md +++ b/packages/docusaurus-1.x/README.md @@ -43,7 +43,7 @@ Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master ### Beginner Friendly Bugs -To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that contain bugs which are fairly easy to fix. This is a great place to get started. +To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that might contain smaller issues to tackle first. This is a great place to get started. ## Contact diff --git a/website-1.x/versioned_docs/version-1.10.x/api-pages.md b/website-1.x/versioned_docs/version-1.10.x/api-pages.md index 17c847fdc6b2..a56f5ee88378 100644 --- a/website-1.x/versioned_docs/version-1.10.x/api-pages.md +++ b/website-1.x/versioned_docs/version-1.10.x/api-pages.md @@ -222,4 +222,4 @@ There are several ways to access the default styles provided for your site. If y 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. -An easy way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. +One way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. diff --git a/website-1.x/versioned_docs/version-1.10.x/api-site-config.md b/website-1.x/versioned_docs/version-1.10.x/api-site-config.md index 819c4ab2f28d..029ca0420c1e 100644 --- a/website-1.x/versioned_docs/version-1.10.x/api-site-config.md +++ b/website-1.x/versioned_docs/version-1.10.x/api-site-config.md @@ -28,7 +28,7 @@ Color configurations for the site. - `primaryColor` is the color used the header navigation bar and sidebars. - `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). -- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to easily configure this color. +- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to configure this color. #### `copyright` [string] diff --git a/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md index ddcede42ecdd..4e7c371747db 100644 --- a/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md @@ -188,7 +188,7 @@ Now, whenever a new commit lands in `master`, CircleCI will run your suite of te When initially deploying to a `gh-pages` branch using CircleCI, you may notice that some jobs triggered by commits to the `gh-pages` branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications). -You can work around this easily by: +You can work around this by: - Setting the environment variable `CUSTOM_COMMIT_MESSAGE` flag to the `publish-gh-pages` command with the contents of `[skip ci]`. e.g. ```bash @@ -241,7 +241,7 @@ Now, whenever a new commit lands in `master`, Travis CI will run your suite of t ### Hosting on ZEIT Now -With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. +With [ZEIT Now](#using-zeit-now), you can deploy your site and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. ### Hosting on Netlify diff --git a/website-1.x/versioned_docs/version-1.10.x/getting-started-site-creation.md b/website-1.x/versioned_docs/version-1.10.x/getting-started-site-creation.md index d7880e368458..49c9363bb746 100644 --- a/website-1.x/versioned_docs/version-1.10.x/getting-started-site-creation.md +++ b/website-1.x/versioned_docs/version-1.10.x/getting-started-site-creation.md @@ -36,7 +36,7 @@ All of your documentation files should be placed inside the `docs` directory as To create a fully functional site, you only need to do a few steps: -1. Add your documentation to the `/docs` directory as `.md` files, ensuring you have the proper [header](api-doc-markdown.md#documents) in each file. The simplest header would be the following, where `id` is the link name (e.g., `docs/intro.html`) and the `title` is the webpage's title. +1. Add your documentation to the `/docs` directory as `.md` files, ensuring you have the proper [header](api-doc-markdown.md#documents) in each file. One example header would be the following, where `id` is the link name (e.g., `docs/intro.html`) and the `title` is the webpage's title. ```yaml --- diff --git a/website-1.x/versioned_docs/version-1.10.x/guides-custom-pages.md b/website-1.x/versioned_docs/version-1.10.x/guides-custom-pages.md index 80659bca55e1..ef90a16edde9 100644 --- a/website-1.x/versioned_docs/version-1.10.x/guides-custom-pages.md +++ b/website-1.x/versioned_docs/version-1.10.x/guides-custom-pages.md @@ -14,7 +14,7 @@ You can [start](getting-started-preparation.md#verifying-installation) your loca ## Adding Other Custom Pages -Docusaurus provides some simple example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. +Docusaurus provides some helpful example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. ```bash root-directory @@ -33,7 +33,7 @@ root-directory └── static ``` -Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). +You are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). > If you want your page to show up in your navigation header, you will need to update `siteConfig.js` to add to the `headerLinks` element. e.g., `{ page: 'about-slash', label: 'About/' }`, diff --git a/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md b/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md index f98f62572f0b..44b6133ae15e 100644 --- a/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md +++ b/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md @@ -263,7 +263,7 @@ These are two separate class names so you can have the active styles applied to ## Secondary On-Page Navigation -We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`. +We support secondary on-page navigation so you can quickly see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`. ```js { diff --git a/website-1.x/versioned_docs/version-1.11.x/api-site-config.md b/website-1.x/versioned_docs/version-1.11.x/api-site-config.md index 7fe8ce70a68a..df8f123a0d83 100644 --- a/website-1.x/versioned_docs/version-1.11.x/api-site-config.md +++ b/website-1.x/versioned_docs/version-1.11.x/api-site-config.md @@ -28,7 +28,7 @@ Color configurations for the site. - `primaryColor` is the color used the header navigation bar and sidebars. - `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). -- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to easily configure this color. +- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to configure this color. #### `copyright` [string] diff --git a/website-1.x/versioned_docs/version-1.11.x/guides-blog.md b/website-1.x/versioned_docs/version-1.11.x/guides-blog.md index ece6c508ada2..59b4f48a7858 100644 --- a/website-1.x/versioned_docs/version-1.11.x/guides-blog.md +++ b/website-1.x/versioned_docs/version-1.11.x/guides-blog.md @@ -95,7 +95,7 @@ blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' }, ## RSS Feed -Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically added to your website page's HTML `` tag. +Docusaurus provides an RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically added to your website page's HTML `` tag. A summary of the post's text is provided in the RSS feed up to the ``. If no `` tag is found, then all text up 250 characters are used. diff --git a/website-1.x/versioned_docs/version-1.11.x/guides-custom-pages.md b/website-1.x/versioned_docs/version-1.11.x/guides-custom-pages.md index 1349600f55d5..79f34b69a92d 100644 --- a/website-1.x/versioned_docs/version-1.11.x/guides-custom-pages.md +++ b/website-1.x/versioned_docs/version-1.11.x/guides-custom-pages.md @@ -14,7 +14,7 @@ You can [start](getting-started-preparation.md#verifying-installation) your loca ## Adding Other Custom Pages -Docusaurus provides some simple example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. +Docusaurus provides some helpful example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. ```bash root-directory @@ -34,7 +34,7 @@ root-directory └── static ``` -Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). +You are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). > If you want your page to show up in your navigation header, you will need to update `siteConfig.js` to add to the `headerLinks` element. e.g., `{ page: 'about-slash', label: 'About/' }`, diff --git a/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md index 33e65ba5bae9..8ee18e44287f 100644 --- a/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md @@ -189,7 +189,7 @@ Now, whenever a new commit lands in `master`, CircleCI will run your suite of te When initially deploying to a `gh-pages` branch using CircleCI, you may notice that some jobs triggered by commits to the `gh-pages` branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications). -You can work around this easily by: +You can work around this by: - Setting the environment variable `CUSTOM_COMMIT_MESSAGE` flag to the `publish-gh-pages` command with the contents of `[skip ci]`. e.g. ```bash @@ -242,7 +242,7 @@ Now, whenever a new commit lands in `master`, Travis CI will run your suite of t ### Hosting on ZEIT Now -With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. +With [ZEIT Now](#using-zeit-now), you can deploy your site and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. ### Hosting on Netlify diff --git a/website-1.x/versioned_docs/version-1.12.0/guides-blog.md b/website-1.x/versioned_docs/version-1.12.0/guides-blog.md index e04d882fe06d..e1647e2fd4f1 100644 --- a/website-1.x/versioned_docs/version-1.12.0/guides-blog.md +++ b/website-1.x/versioned_docs/version-1.12.0/guides-blog.md @@ -95,7 +95,7 @@ blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' }, ## RSS Feed -Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically added to your website page's HTML `` tag. +Docusaurus provides an RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically added to your website page's HTML `` tag. A summary of the post's text is provided in the RSS feed up to the ``. If no `` tag is found, then all text up to 250 characters is used. diff --git a/website-1.x/versioned_docs/version-1.13.0/api-site-config.md b/website-1.x/versioned_docs/version-1.13.0/api-site-config.md index ed8a0dffc98c..536b60a4e163 100644 --- a/website-1.x/versioned_docs/version-1.13.0/api-site-config.md +++ b/website-1.x/versioned_docs/version-1.13.0/api-site-config.md @@ -28,7 +28,7 @@ Color configurations for the site. - `primaryColor` is the color used the header navigation bar and sidebars. - `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). -- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to easily configure this color. +- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to configure this color. #### `copyright` [string] diff --git a/website-1.x/versioned_docs/version-1.14.0/api-site-config.md b/website-1.x/versioned_docs/version-1.14.0/api-site-config.md index b743d36f4bbf..806fafb0e33f 100644 --- a/website-1.x/versioned_docs/version-1.14.0/api-site-config.md +++ b/website-1.x/versioned_docs/version-1.14.0/api-site-config.md @@ -28,7 +28,7 @@ Color configurations for the site. - `primaryColor` is the color used the header navigation bar and sidebars. - `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). -- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to easily configure this color. +- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to configure this color. #### `copyright` [string] diff --git a/website-1.x/versioned_docs/version-1.9.x/api-pages.md b/website-1.x/versioned_docs/version-1.9.x/api-pages.md index c31ef86a52c7..b9c8c3459e8d 100644 --- a/website-1.x/versioned_docs/version-1.9.x/api-pages.md +++ b/website-1.x/versioned_docs/version-1.9.x/api-pages.md @@ -222,4 +222,4 @@ There are several ways to access the default styles provided for your site. If y 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. -An easy way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. +One way to figure out what classes you wish to override or add to is to [start your server locally](api-commands.md) and use your browser's inspect element tool. diff --git a/website-1.x/versioned_docs/version-1.9.x/api-site-config.md b/website-1.x/versioned_docs/version-1.9.x/api-site-config.md index 79cfa2ff9491..3809635d4ffc 100644 --- a/website-1.x/versioned_docs/version-1.9.x/api-site-config.md +++ b/website-1.x/versioned_docs/version-1.9.x/api-site-config.md @@ -28,7 +28,7 @@ Color configurations for the site. - `primaryColor` is the color used the header navigation bar and sidebars. - `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). -- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to easily configure this color. +- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to configure this color. #### `copyright` [string] diff --git a/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md index 55113b7a4a52..749f99213183 100644 --- a/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md @@ -188,7 +188,7 @@ Now, whenever a new commit lands in `master`, CircleCI will run your suite of te When initially deploying to a `gh-pages` branch using CircleCI, you may notice that some jobs triggered by commits to the `gh-pages` branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications). -You can work around this easily by: +You can work around this by: - Setting the environment variable `CUSTOM_COMMIT_MESSAGE` flag to the `publish-gh-pages` command with the contents of `[skip ci]`. e.g. ```bash @@ -241,7 +241,7 @@ Now, whenever a new commit lands in `master`, Travis CI will run your suite of t ### Hosting on ZEIT Now -With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. +With [ZEIT Now](#using-zeit-now), you can deploy your site and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. ### Hosting on Netlify diff --git a/website-1.x/versioned_docs/version-1.9.x/getting-started-site-creation.md b/website-1.x/versioned_docs/version-1.9.x/getting-started-site-creation.md index 1f1944fb9f7c..ef40e8c7059b 100644 --- a/website-1.x/versioned_docs/version-1.9.x/getting-started-site-creation.md +++ b/website-1.x/versioned_docs/version-1.9.x/getting-started-site-creation.md @@ -36,7 +36,7 @@ All of your documentation files should be placed inside the `docs` directory as To create a fully functional site, you only need to do a few steps: -1. Add your documentation to the `/docs` directory as `.md` files, ensuring you have the proper [header](api-doc-markdown.md#documents) in each file. The simplest header would be the following, where `id` is the link name (e.g., `docs/intro.html`) and the `title` is the webpage's title. +1. Add your documentation to the `/docs` directory as `.md` files, ensuring you have the proper [header](api-doc-markdown.md#documents) in each file. One example header would be the following, where `id` is the link name (e.g., `docs/intro.html`) and the `title` is the webpage's title. ```yaml --- diff --git a/website-1.x/versioned_docs/version-1.9.x/guides-blog.md b/website-1.x/versioned_docs/version-1.9.x/guides-blog.md index 531ee1bb5b85..c627505c4c54 100644 --- a/website-1.x/versioned_docs/version-1.9.x/guides-blog.md +++ b/website-1.x/versioned_docs/version-1.9.x/guides-blog.md @@ -95,7 +95,7 @@ blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' }, ## RSS Feed -Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML `` tag. +Docusaurus provides an RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML `` tag. A summary of the post's text is provided in the RSS feed up to the ``. If no `` tag is found, then all text up 250 characters are used. diff --git a/website-1.x/versioned_docs/version-1.9.x/guides-custom-pages.md b/website-1.x/versioned_docs/version-1.9.x/guides-custom-pages.md index 86c89d32f533..ed051c4418fa 100644 --- a/website-1.x/versioned_docs/version-1.9.x/guides-custom-pages.md +++ b/website-1.x/versioned_docs/version-1.9.x/guides-custom-pages.md @@ -14,7 +14,7 @@ You can [start](getting-started-preparation.md#verifying-installation) your loca ## Adding Other Custom Pages -Docusaurus provides some simple example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. +Docusaurus provides some helpful example pages in the `website/pages/en` directory, including `index.js`, `users.js`, and `help.js`. These are good examples to showcase how to create a custom page for Docusaurus. ```bash root-directory @@ -33,7 +33,7 @@ root-directory └── static ``` -Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). +You are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. More information on how to use the provided components or include your own can be found [here](api-pages.md). Information on how to link to your different pages in the header navigation bar can be found [here](guides-navigation.md). > If you want your page to show up in your navigation header, you will need to update `siteConfig.js` to add to the `headerLinks` element. e.g., `{ page: 'about-slash', label: 'About/' }`, diff --git a/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md b/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md index c22886704bae..3eac28ddb4e8 100644 --- a/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md +++ b/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md @@ -263,7 +263,7 @@ These are two separate class names so you can have the active styles applied to ## Secondary On-Page Navigation -We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`. +We support secondary on-page navigation so you can quickly see the topics associated with a given document. To enable this feature, you need to add the `onPageNav` site configuration [option](api-site-config.md#optional-fields) to your `siteConfig.js`. ```js { diff --git a/website/docs/configuration.md b/website/docs/configuration.md index d995412538e6..4a73cb6217bd 100644 --- a/website/docs/configuration.md +++ b/website/docs/configuration.md @@ -5,7 +5,7 @@ title: Configuration Docusaurus has a unique take on configurations. We encourage you to congregate information of your site into one place. We will guard the fields of this file, and facilitate making this data object accessible across your site. -Keeping a well-maintained `docusaurus.config.js` helps you, your collaborators, and your open source contributors be able to focus on documentation while still being able to easily customize fields. +Keeping a well-maintained `docusaurus.config.js` helps you, your collaborators, and your open source contributors be able to focus on documentation while still being able to customize fields. ## What goes into `docusaurus.config.js`? diff --git a/website/docs/contributing.md b/website/docs/contributing.md index 86bace34da7d..dccc096b94cb 100644 --- a/website/docs/contributing.md +++ b/website/docs/contributing.md @@ -183,7 +183,7 @@ In order to accept your pull request, we need you to submit a CLA. You only need ### What happens next? -The core Docusaurus team will be monitoring for pull requests. Do help us by making your pull request easy to review by following the guidelines above. +The core Docusaurus team will be monitoring for pull requests. Do help us by keeping pull requests consistent by following the guidelines above. ## License diff --git a/website/docs/introduction.md b/website/docs/introduction.md index 6a9085d63b96..39ed20d69169 100644 --- a/website/docs/introduction.md +++ b/website/docs/introduction.md @@ -41,7 +41,7 @@ Docusaurus is built with high attention to your experience building your site an - Open source your plugins to share with your fellow documentarians, because sharing is caring. - βœ‚οΈ **Developer experience** - Multiple bootstrapping templates to get your site up and running, start writing your docs right now - - Universal configuration entry point to make it easily maintainable by contributors + - Universal configuration entry point to make it more maintainable by contributors - Hot reloading with lightning fast incremental build on changes - Route-based code and data splitting - Publish to GitHub Pages, Netlify, and other deployment services with ease diff --git a/website/docs/markdown-features.mdx b/website/docs/markdown-features.mdx index 5c7deb63f471..cad62c6356ec 100644 --- a/website/docs/markdown-features.mdx +++ b/website/docs/markdown-features.mdx @@ -10,7 +10,7 @@ combining: - markdown features --> -Documentation is one of your product's interfaces with your users. A well-written and well-organized set of docs helps your users understand your product quickly. Our aligned goal here is to help your users find and understand the information they need, as easily as possible. +Documentation is one of your product's interfaces with your users. A well-written and well-organized set of docs helps your users understand your product quickly. Our aligned goal here is to help your users find and understand the information they need, as quickly as possible. Docusaurus 2 uses modern tooling to help you compose your interactive documentations with ease. You may embed React components, or build live coding blocks where your users may play with the code on the spot. Start sharing your eureka moments with the code your audience cannot walk away from. It is perhaps the most effective way of attracting potential users. @@ -20,7 +20,7 @@ In this section, we'd like to introduce you to the tools we've picked that we be --- -Markdown is a syntax that enables you to write formatted content in an easy-to-use syntax. The [standard Markdown syntax](https://daringfireball.net/projects/markdown/syntax) is supported and we use [MDX](https://mdxjs.com/) as the parsing engine, which can do much more than just parsing Markdown. More on that later. +Markdown is a syntax that enables you to write formatted content in a readable syntax. The [standard Markdown syntax](https://daringfireball.net/projects/markdown/syntax) is supported and we use [MDX](https://mdxjs.com/) as the parsing engine, which can do much more than just parsing Markdown. More on that later. Create a markdown file, `greeting.md`, and place it under the `docs` directory. diff --git a/website/docs/search.md b/website/docs/search.md index 5f96356de391..e01bfb4d2393 100644 --- a/website/docs/search.md +++ b/website/docs/search.md @@ -6,7 +6,7 @@ keywords: - search --- -Docusaurus's own `@docusaurus/preset-classic` supports easy search integration. +Docusaurus's own `@docusaurus/preset-classic` supports a search integration. There are two main options, you can use [Algolia DocSearch](https://community.algolia.com/docsearch/) or bring in your own `SearchBar` component. diff --git a/website/docs/using-themes.md b/website/docs/using-themes.md index 6eb675df065d..f6700a59f413 100644 --- a/website/docs/using-themes.md +++ b/website/docs/using-themes.md @@ -4,7 +4,7 @@ title: Themes sidebar_label: Introduction --- -Like plugins, themes are designed to add functionality to your Docusaurus site. As a good rule of thumb, themes are mostly focused on client-side, where plugins are more focused on server-side functionalities. Themes are also designed to be easily replace-able with other themes. +Like plugins, themes are designed to add functionality to your Docusaurus site. As a good rule of thumb, themes are mostly focused on client-side, where plugins are more focused on server-side functionalities. Themes are also designed to be replace-able with other themes. ## Using themes @@ -75,7 +75,7 @@ The content plugin remains the same and the only thing you need to change is the ## Swizzling theme components -Docusaurus Themes' components are designed to be easily replaceable. To make it easier for you, we created a command for you to replace theme components called `swizzle`. +Docusaurus Themes' components are designed to be replaceable. To make it easier for you, we created a command for you to replace theme components called `swizzle`. To swizzle a component for a theme, run the following command in your doc site: