docs: promote Docusaurus 2 usage (#2126)

This commit is contained in:
Yangshun Tay 2019-12-15 17:49:25 +08:00 committed by GitHub
parent dcf1fef001
commit 19acc44d81
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 5 deletions

View file

@ -6,6 +6,8 @@ description: Docusaurus was designed from the ground up to be easily installed a
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
> **Important Note:** If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use [Docusaurus 2](https://v2.docusaurus.io) instead.
## Installing Docusaurus
We have created a helpful script that will get all of the infrastructure set up for you:

View file

@ -62,12 +62,14 @@ class Index extends React.Component {
<HomeSplash siteConfig={siteConfig} language={language} />
<div className="announcement">
<div className="announcement-inner">
We're working on{' '}
<a href="https://github.com/facebook/docusaurus/issues/789">
Docusaurus 2
If you don't need advanced features such as versioning or
translations, try out
<a href="https://v2.docusaurus.io">Docusaurus 2</a> instead!
Contribute to its roadmap by suggesting features or{' '}
<a href="https://v2.docusaurus.io/feedback/">
giving feedback here
</a>
, contribute to its roadmap by suggesting features or giving
feedback <a href="https://v2.docusaurus.io/feedback/">here</a>!
!
</div>
</div>
<div className="mainContainer">

View file

@ -26,6 +26,12 @@ npx @docusaurus/init@next init my-website classic
If you do not specify `name` or `template`, it will prompt you for them. We recommend the `classic` template so that you can get started quickly and it contains features found in Docusaurus 1. The `classic` template contains `@docusaurus/preset-classic` which includes standard documentation, a blog, custom pages, and a CSS framework (with dark mode support). You can get up and running extremely quickly with the classic template and customize things later on when you have gained more familiarity with Docusaurus.
**Important Note:** If you are setting up a new Docusaurus website for a Facebook open source project, use the `facebook` template instead, which comes with some useful Facebook-specific defaults:
```bash
npx @docusaurus/init@next init my-website facebook
```
## Project structure
Assuming you chose the classic template and named your site `my-website`, you will see the following files generated under a new directory `my-website/`: