-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
133 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
website/versioned_docs/version-1.1.4/getting-started-installation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
id: version-1.1.4-installation | ||
title: Installation | ||
original_id: installation | ||
--- | ||
|
||
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you: | ||
|
||
1. Ensure you have the latest version of [Node](https://nodejs.org/en/download/) installed. We also recommend you install [Yarn](https://yarnpkg.com/en/docs/install) as well. | ||
|
||
> While we recommend Node 8.x or greater, your Node version must at least 6.x. | ||
1. Go into the root of your GitHub repo directory where you will be creating the docs. | ||
1. `npx docusaurus-init` | ||
|
||
> If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run `yarn global add docusaurus-init` or `npm install --global docusaurus-init`. After that, run `docusaurus-init`. | ||
After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the `website` directory and typing `yarn outdated docusaurus` or `npm outdated docusaurus`. You can update to the [latest version](https://www.npmjs.com/package/docusaurus) of Docusaurus by typing `yarn upgrade docusaurus --latest` or `npm update docusaurus`. | ||
|
||
## Verifying Installation | ||
|
||
Along with previously existing files and directories, your root directory will now contain a structure similar to: | ||
|
||
```bash | ||
root-directory | ||
├── docs-examples-from-docusaurus | ||
│ ├── doc1.md | ||
│ ├── doc2.md | ||
│ ├── doc3.md | ||
│ ├── exampledoc4.md | ||
│ └── exampledoc5.md | ||
└── website | ||
├── blog-examples-from-docusaurus | ||
│ ├── 2016-03-11-blog-post.md | ||
│ ├── 2017-04-10-blog-post-two.md | ||
│ ├── 2017-09-25-testing-rss.md | ||
│ ├── 2017-09-26-adding-rss.md | ||
│ └── 2017-10-24-new-version-1.0.0.md | ||
├── core | ||
│ └── Footer.js | ||
├── package.json | ||
├── pages | ||
├── sidebars.json | ||
├── siteConfig.js | ||
└── static | ||
``` | ||
|
||
Running the Docusaurus initialization script, `docusaurus-init`, produces a runnable, example website to base your site upon. | ||
|
||
1. In your root, rename `docs-examples-from-docusaurus` to `docs`. | ||
1. `cd website` | ||
1. Rename `blog-examples-from-docusaurus` to `blog`. | ||
1. Run the local webserver via `yarn start` or `npm start`. | ||
1. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. | ||
|
||
![](/img/getting-started-preparation-verify.png) | ||
|
||
### Launching the server behind a proxy | ||
|
||
If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the `NO_PROXY` environment variable. | ||
|
||
```sh | ||
SET NO_PROXY=localhost | ||
yarn start (or npm run start) | ||
``` |
48 changes: 48 additions & 0 deletions
48
website/versioned_docs/version-1.1.4/getting-started-preparation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
id: version-1.1.4-site-preparation | ||
title: Site Preparation | ||
original_id: site-preparation | ||
--- | ||
|
||
After [installing Docusaurus](getting-started-installation.md), you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site. | ||
|
||
## Directory Structure | ||
|
||
As shown after you [installed Docusaurus](getting-started-installation.md), the initialization script created a directory structure similar to: | ||
|
||
```bash | ||
root-directory | ||
├── docs-examples-from-docusaurus | ||
│ ├── doc1.md | ||
│ ├── doc2.md | ||
│ ├── doc3.md | ||
│ ├── exampledoc4.md | ||
│ └── exampledoc5.md | ||
└── website | ||
├── blog-examples-from-docusaurus | ||
│ ├── 2016-03-11-blog-post.md | ||
│ ├── 2017-04-10-blog-post-two.md | ||
│ ├── 2017-09-25-testing-rss.md | ||
│ ├── 2017-09-26-adding-rss.md | ||
│ └── 2017-10-24-new-version-1.0.0.md | ||
├── core | ||
│ └── Footer.js | ||
├── package.json | ||
├── pages | ||
├── sidebars.json | ||
├── siteConfig.js | ||
└── static | ||
``` | ||
|
||
> You may have already renamed the example blog (`website/blog-examples-from-docusaurus`) and document (`docs-examples-from-docusaurus`) directories when you [verified the installation](getting-started-installation.md##verifying-installation). | ||
- The `website/core/Footer.js` file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user. | ||
- The `website/blog-examples-from-docusaurus` folder contains examples of blog posts written in markdown. | ||
- The `docs-examples-from-docusaurus` folder contains example documentation files written in markdown. | ||
- The `website/pages` folder contains example top-level pages for the site. | ||
- The `website/static` folder contains static assets used by the example site. | ||
- The `website/siteConfig.js` file is the main configuration file used by Docusaurus. | ||
|
||
You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. | ||
|
||
You should keep the `website/pages` and `website/static` folders, but may change the content inside them as you wish. At the bare minimum you should have an `en/index.js` or `en/index.html` file inside `website/pages` and an image to use as your header icon inside `website/static`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
[ | ||
"1.1.4", | ||
"1.1.3", | ||
"1.1.2", | ||
"1.1.1", | ||
|