Publish v1.1.3 (#695)

This commit is contained in:
Joel Marcey 2018-05-23 11:28:02 -07:00 committed by GitHub
parent d14d3c2092
commit d143b3f87e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 2305 additions and 2274 deletions

View file

@ -6,6 +6,23 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
## [Unreleased]
## [1.1.3] - 2018-05-23
`npm` had an issue where some packages were not being published. This should hopefully be resolved now; publishing a new version just in case.
Also, welcome [TextLint](https://textlint.github.io/) and [Open Power Quality](https://openpowerquality.org/) as new [users](https://docusaurus.io/en/users.html).
Thank you to the following contributors who helped with this release:
- @azu
- @philipmjohnson
- @violabg
- @sebelga
### Fixed/Changed
- `onPageNav` now [shows](https://github.com/facebook/Docusaurus/commit/2c74d937607fcd84677be5d6990ca2a3b4ba8d7a) in Safari.
## [1.1.2] - 2018-05-21
Another HOTFIX release. One of our third-party dependencies, `tree-node-cli` didn't support Node 10+. The package has been fixed and we have updated to use the new version of that package.
@ -424,7 +441,8 @@ N/A
- Blog
- Documentation
[Unreleased]: https://github.com/facebook/Docusaurus/compare/v1.1.2...HEAD
[Unreleased]: https://github.com/facebook/Docusaurus/compare/v1.1.3...HEAD
[1.1.3]: https://github.com/facebook/Docusaurus/compare/v1.1.2...v1.1.3
[1.1.2]: https://github.com/facebook/Docusaurus/compare/v1.1.1...v1.1.2
[1.1.1]: https://github.com/facebook/Docusaurus/compare/v1.1.0...v1.1.1
[1.1.0]: https://github.com/facebook/Docusaurus/compare/v1.0.15...v1.1.0

View file

@ -11,8 +11,11 @@ If you are not currently logged into npm locally:
## Publish
1. Bump version number in `package.json`
2. `npm publish`
1. Bump version number in [`package.json`](https://github.com/facebook/Docusaurus/blob/master/package.json).
1. Update the [change log](https://github.com/facebook/Docusaurus/blob/master/CHANGELOG.md).
1. Run `npm install` and `yarn install` to update `package-lock.json` and/or `yarn.lock`.
1. From the `website` directory, run `npm run version x.x.x`, where x.x.x is the same version number you updated to in `package.json`.
1. Run `npm publish`
### What version should you use?

4484
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -1,7 +1,7 @@
{
"name": "docusaurus",
"description": "Easy to Maintain Open Source Documentation Websites",
"version": "1.1.2",
"version": "1.1.3",
"license": "MIT",
"keywords": [
"documentation",
@ -61,7 +61,7 @@
"sitemap": "^1.13.0",
"tcp-port-used": "^0.1.2",
"tiny-lr": "^1.1.1",
"tree-node-cli": "^1.2.0"
"tree-node-cli": "^1.2.1"
},
"bin": {
"docusaurus-start": "./lib/start-server.js",

View file

@ -0,0 +1,63 @@
---
id: version-1.1.3-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-of-repo
├── 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
├── core
│ └── Footer.js
├── node_modules
├── 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)
```

View file

@ -1,4 +1,5 @@
[
"1.1.3",
"1.1.2",
"1.1.1",
"1.1.0",