Skip to content

Commit

Permalink
docs(v2): quick proofread docs (#2068)
Browse files Browse the repository at this point in the history
  • Loading branch information
endiliey authored and yangshun committed Nov 29, 2019
1 parent dffa984 commit 522dd2d
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion website/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ We have a list of [beginner friendly issues](https://github.com/facebook/docusau

If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also file an issue with [feature template](https://github.com/facebook/docusaurus/issues/new?template=feature.md).

If you intend to change the public API (e.g., something in `siteConfig.js`), or make any non-trivial changes to the implementation, we recommend filing an issue with [proposal template](https://github.com/facebook/docusaurus/issues/new?template=proposal.md) and including `[Proposal]` in the title. This lets us reach an agreement on your proposal before you put significant effort into it. These types of issues should be rare.
If you intend to change the public API (e.g., something in `docusaurus.config.js`), or make any non-trivial changes to the implementation, we recommend filing an issue with [proposal template](https://github.com/facebook/docusaurus/issues/new?template=proposal.md) and including `[Proposal]` in the title. This lets us reach an agreement on your proposal before you put significant effort into it. These types of issues should be rare.

If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend to file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ This is an **early and alpha release** of Docusaurus 2. We are making it availab
**Do not use this if**

- :x: You need a full production-ready solution (<small>try [Docusaurus 1](https://docusaurus.io/) instead</small>)
- :x: You need the versioning and translation features present in v1
- :x: You need the translation features present in v1
- :x: You prefer not to work with potential breaking changes and/or features not yet working properly as we improve it during alpha period

## A better Docusaurus is coming to town

<img alt="Docusaurus " src={useBaseUrl('img/slash-introducing.svg')} />

Docusaurus 1 used to be a pure documentation site generator. In Docusaurus 2, we rebuilt it from the ground up, allowing for more customizability but preserved the best parts of Docusaurus 1 - easy to get started, versioned docs (_coming soon_), and i18n (_coming soon_).
Docusaurus 1 used to be a pure documentation site generator. In Docusaurus 2, we rebuilt it from the ground up, allowing for more customizability but preserved the best parts of Docusaurus 1 - easy to get started, versioned docs, and i18n (_coming soon_).

Beyond that, Docusaurus 2 is a **performant static site generator** and can be used to create most content-driven websites (e.g. Documentation, Blogs, Product Landing and Marketing Pages, etc) extremely fast.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@ Lorem ipsum

As the name implies, `SidebarItem` is an item defined in a Sidebar. There are a few types we support:

- Doc
- Link
- Ref
- Category
- [Doc](#doc)
- [Link](#link)
- [Ref](#ref)
- [Category](#category)

### Doc

Expand Down
2 changes: 0 additions & 2 deletions website/docs/static-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ In general, every website needs assets: images, stylesheets, favicons and etc. I

This means that if the site's `baseUrl` is `/`, an image in `/static/img/docusaurus_keytar.svg` is available at `/img/docusaurus_keytar.svg`.

<!-- TODO: Yangshun: This is inaccurate for sites with a non '/' baseUrl -->

## Referencing your static asset

You can reference assets from the `static` folder in your code. You could use hardcoded absolute paths, i.e. starting with a slash /, but remember to include the `baseUrl` if it is not `/`. However, this will break if you change your `baseUrl` in the config.
Expand Down
1 change: 1 addition & 0 deletions website/docs/styling-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ When you `init` your Docusaurus 2 project, the website will be generated with ba
--ifm-color-primary-light: rgb(70, 203, 174);
--ifm-color-primary-lighter: rgb(102, 212, 189);
--ifm-color-primary-lightest: rgb(146, 224, 208);
--ifm-code-font-size: 95%;
}
```

Expand Down

0 comments on commit 522dd2d

Please sign in to comment.