From 0d489aeb9e7eed322b94344f03d84dbfe493896b Mon Sep 17 00:00:00 2001 From: Franklyn Chisom <57289189+ajifrank75@users.noreply.github.com> Date: Fri, 14 Aug 2020 10:38:54 +0100 Subject: [PATCH] docs: corrected some few typos in the docusaurus tech docs (#3276) * corrected some few typos * Update blog.md Co-authored-by: Yangshun Tay --- CHANGELOG.md | 2 +- docs/api-site-config.md | 2 +- website/docs/blog.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 88d47487a872..dea2404d5d05 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -810,7 +810,7 @@ None that we know of. Please let us know if you find any as this is a big releas ### Added -- Sub-directories are now [supported](https://github.com/facebook/docusaurus/commit/d04b3ca87bb371dd47e6b69a863306ee5f2b1840) for documentation. This was one of most [requested features](https://github.com/facebook/docusaurus/pull/705). +- Sub-directories are now [supported](https://github.com/facebook/docusaurus/commit/d04b3ca87bb371dd47e6b69a863306ee5f2b1840) for documentation. This was one of the most [requested features](https://github.com/facebook/docusaurus/pull/705). - You can now use [Prism for syntax highlighting](https://github.com/facebook/docusaurus/commit/c8bc00a3a78f6db8f9a9e22aaaf63f56a00cc2ac), in addition to Highlight.js. [Documentation](https://docusaurus.io/docs/en/doc-markdown#using-prism-as-additional-syntax-highlighter) - URLs can now be ["clean"](https://github.com/facebook/docusaurus/commit/31f0c27f81ac9d22f8fdd29f5265e60b5b038773) - no `.html` extension. - Scroll to top button [option](https://github.com/facebook/docusaurus/commit/aee255219bedc97b55048cdb4703742cbb7c247e) for your documentation pages. diff --git a/docs/api-site-config.md b/docs/api-site-config.md index 68accd3eb423..e78aeb03f185 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -7,7 +7,7 @@ A large part of the site configuration is done by editing the `siteConfig.js` fi ## 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 someone. 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 the example `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/website/docs/blog.md b/website/docs/blog.md index 70322e07d02a..26c68dfafe5d 100644 --- a/website/docs/blog.md +++ b/website/docs/blog.md @@ -7,7 +7,7 @@ title: Blog To setup your site's blog, start by creating a `blog` directory. -Then, add a item link to your blog within `docusaurus.config.js`: +Then, add an item link to your blog within `docusaurus.config.js`: ```js title="docusaurus.config.js" module.exports = { @@ -60,7 +60,7 @@ The only required field is `title`; however, we provide options to add author in - `author_title` - A description of the author. - `title` - The blog post title. - `tags` - A list of strings to tag to your post. -- `draft` - A boolean flag to indicate that the blog post is work in process and therefore should not be published yet. However, draft blog posts will be displayed during development. +- `draft` - A boolean flag to indicate that the blog post is work-in-progress and therefore should not be published yet. However, draft blog posts will be displayed during development. - `description`: The description of your post, which will become the `` and `` in ``, used by search engines. If this field is not present, it will default to the first line of the contents. - `image`: Cover or thumbnail image that will be used when displaying the link to your post. @@ -72,7 +72,7 @@ Use the `` marker in your blog post to represent what will be sho --- title: Truncation Example --- -All this will be part of the blog post summary. +All these will be part of the blog post summary. Even this.