Skip to content

Commit

Permalink
docs: corrected some few typos in the docusaurus tech docs (#3276)
Browse files Browse the repository at this point in the history
* corrected some few typos

* Update blog.md

Co-authored-by: Yangshun Tay <[email protected]>
  • Loading branch information
mrUnlimited2020 and yangshun authored Aug 14, 2020
1 parent e919657 commit 0d489ae
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/api-site-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -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 `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`, 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.

Expand All @@ -72,7 +72,7 @@ Use the `<!--truncate-->` 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.

Expand Down

0 comments on commit 0d489ae

Please sign in to comment.