From b5fefcc6766eec34f221e4fb7a4dde4c39074f70 Mon Sep 17 00:00:00 2001 From: Thomas Broadley Date: Wed, 20 Dec 2017 00:39:18 -0500 Subject: [PATCH] docs: fix typos (#327) --- admin/extending-remarkable.md | 2 +- admin/local-third-party-project-testing.md | 2 +- admin/testing-changes-on-Docusaurus-itself.md | 2 +- docs/api-pages.md | 2 +- docs/api-site-config.md | 2 +- docs/guides-blog.md | 2 +- docs/guides-navigation.md | 2 +- docs/guides-translation.md | 4 ++-- website/blog/2017-12-14-introducing-docusaurus.md | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/admin/extending-remarkable.md b/admin/extending-remarkable.md index 4d37834464..f2f9f7db0b 100644 --- a/admin/extending-remarkable.md +++ b/admin/extending-remarkable.md @@ -32,7 +32,7 @@ A block token is a bit more complex. It may wrap one or more tokens, and can spa The plain markdown text above would be parsed into three tokens: -- `heading_open`: Marks the begining of the heading. May have additional props, such as `hLevel: 3` (heading level) in this case. +- `heading_open`: Marks the beginning of the heading. May have additional props, such as `hLevel: 3` (heading level) in this case. - `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. diff --git a/admin/local-third-party-project-testing.md b/admin/local-third-party-project-testing.md index 471fcfc7ae..03bc538472 100644 --- a/admin/local-third-party-project-testing.md +++ b/admin/local-third-party-project-testing.md @@ -1,6 +1,6 @@ Sometimes you want to test the latest version of Docusaurus on a third-party project via `npm` or `yarn` without having to publish it to npm itself. For example, you may want to use the latest code in `master`. -> If you want to use Docusaurus to test Docusuarus, see the [testing changins on Docusaurus itself doc](./testing-changes-on-Docusaurus-itself.md) +> If you want to use Docusaurus to test Docusaurus, see the [testing changes on Docusaurus itself doc](./testing-changes-on-Docusaurus-itself.md) There are two reasonable ways to use a local version of the Docusaurus npm package to test changes you make to the Docusaurus core on a third-party project. diff --git a/admin/testing-changes-on-Docusaurus-itself.md b/admin/testing-changes-on-Docusaurus-itself.md index db88b29841..a284a61505 100644 --- a/admin/testing-changes-on-Docusaurus-itself.md +++ b/admin/testing-changes-on-Docusaurus-itself.md @@ -1,4 +1,4 @@ -If you are developing the Docusuarus core and you want a quick way to test your changes, you can use the Docusaurus website itself as your testing area. +If you are developing the Docusaurus core and you want a quick way to test your changes, you can use the Docusaurus website itself as your testing area. > For tips on testing other projects, see the [local testing of third-party projects doc](./local-third-party-project-testing.md). diff --git a/docs/api-pages.md b/docs/api-pages.md index 3e5f8dab13..e46ed96c6b 100644 --- a/docs/api-pages.md +++ b/docs/api-pages.md @@ -122,7 +122,7 @@ Note that this path is valid for files inside `pages/en` and should be adjusted ## Using Static Assets -Static assets should be placed into the `website/static` folder. They can be accesssed by their paths, excluding "static". For example, if the site's `baseUrl` is "/docusaurus/", an image in `website/static/img/logo.png` is available at `/docusaurus/img/logo.png`. +Static assets should be placed into the `website/static` folder. They can be accessed by their paths, excluding "static". For example, if the site's `baseUrl` is "/docusaurus/", an image in `website/static/img/logo.png` is available at `/docusaurus/img/logo.png`. ## Styles diff --git a/docs/api-site-config.md b/docs/api-site-config.md index c66768c531..52aac9d308 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -7,7 +7,7 @@ A large part of site configuration is done by editing the `siteConfig.js` file. ## User Showcase -The `users` array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the `pages/en/index.js` and `pages/en/users.js` files provided. Each user object should have `caption`, `image`, `infoLink`, and `pinned` fields. The `caption` is the text showed when someone hovers over the `image` of that user, and the `infoLink` is where clicking the image will bring someon. The `pinned` field determines whether or not it shows up on the `index` page. +The `users` array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the `pages/en/index.js` and `pages/en/users.js` files provided. Each user object should have `caption`, `image`, `infoLink`, and `pinned` fields. The `caption` is the text showed when someone hovers over the `image` of that user, and the `infoLink` is where clicking the image will bring someone. The `pinned` field determines whether or not it shows up on the `index` page. Currently this `users` array is used only by the `index.js` and `users.js` example files. If you do not wish to have a users page or show users on the `index` page, you may remove this section. diff --git a/docs/guides-blog.md b/docs/guides-blog.md index 549abe4bad..b59519fe7a 100644 --- a/docs/guides-blog.md +++ b/docs/guides-blog.md @@ -72,7 +72,7 @@ Or this. 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. -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 chacters are used. +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. ## Social Buttons diff --git a/docs/guides-navigation.md b/docs/guides-navigation.md index 4be70019ee..b3acdce4b5 100644 --- a/docs/guides-navigation.md +++ b/docs/guides-navigation.md @@ -69,7 +69,7 @@ You can also put a document in a new sidebar. In the following example, we are c ... ``` -It is important to note that until you [add a document from the the `"examples-sidebar"` sidebar to the nav bar](#additions-to-the-site-navigation-bar), it will be hidden. +It is important to note that until you [add a document from the `"examples-sidebar"` sidebar to the nav bar](#additions-to-the-site-navigation-bar), it will be hidden. ## Additions to the Site Navigation Bar diff --git a/docs/guides-translation.md b/docs/guides-translation.md index 18b0158e88..fa85289523 100644 --- a/docs/guides-translation.md +++ b/docs/guides-translation.md @@ -7,7 +7,7 @@ Docusaurus allows for easy translation functionality using [Crowdin](https://cro ## Docusaurus Translation Configurations -To generate example files for translations with Docusuaurus, run the `examples` script with the command line argument `translations`: +To generate example files for translations with Docusaurus, run the `examples` script with the command line argument `translations`: ``` npm run examples translations @@ -163,7 +163,7 @@ You can add the following to your `package.json` to manually trigger crowdin. These commands require having an environment variable set with your crowdin project id and api key (`CROWDIN_PROJECT_ID`, `CROWDIN_API_KEY`). You can add them inline like above or add them permanently to your `.bashrc` or `.bash_profile`. -If you run more than one localized Docusaurus project on your computer, you should change the name of the enviroment variables to something unique (`CROWDIN_PROJECTNAME_PROJECT_ID`, `CROWDIN_PROJECTNAME_API_KEY`). +If you run more than one localized Docusaurus project on your computer, you should change the name of the environment variables to something unique (`CROWDIN_PROJECTNAME_PROJECT_ID`, `CROWDIN_PROJECTNAME_API_KEY`). ### Automated File Sync Using CircleCI diff --git a/website/blog/2017-12-14-introducing-docusaurus.md b/website/blog/2017-12-14-introducing-docusaurus.md index dbbbe7c0b3..2aa47fcf44 100644 --- a/website/blog/2017-12-14-introducing-docusaurus.md +++ b/website/blog/2017-12-14-introducing-docusaurus.md @@ -18,7 +18,7 @@ We created [Docusaurus](https://docusaurus.io) for the following reasons: -Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. At its core, all a user has to provide are documentation files written in markdown, customization of a provided home page written in React, and a few configuration modifications. Docusaurus handles the rest by providing default styles, site formatting, and simple document navigation. Getting started is easy, as users can [install](https://docusaurus.io/docs/en/installation.html) it using `npm` or `yarn` via a simple initialzation script that [creates a working example website out of the box](https://docusaurus.io/docs/en/site-preparation.html). +Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. At its core, all a user has to provide are documentation files written in markdown, customization of a provided home page written in React, and a few configuration modifications. Docusaurus handles the rest by providing default styles, site formatting, and simple document navigation. Getting started is easy, as users can [install](https://docusaurus.io/docs/en/installation.html) it using `npm` or `yarn` via a simple initialization script that [creates a working example website out of the box](https://docusaurus.io/docs/en/site-preparation.html). Docusaurus also provides core website and documentation features out-of-the-box including [blog support](https://docusaurus.io/docs/en/blog.html), [internationalization](https://docusaurus.io/docs/en/translation.html), [search](https://docusaurus.io/docs/en/search.html), and [versioning](https://docusaurus.io/docs/en/versioning.html). While some projects may not require any of these features, enabling them is generally a matter of updating configuration options instead of having to add the infrastructure from the ground up. As more features get added to Docusaurus, users just can easily update to the latest version. This can be done by simply running npm or yarn update and updating configuration options. Users or teams will no longer need to manually rework their entire website infrastructure each time a new feature gets added.