Merge remote-tracking branch 'upstream/master' into will-sub-categories

CHANGELOG.md

@@ -6,6 +6,69 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.3.3] - 2018-08-22
+
+Welcome to our newest users, [atalaya](https://atalaya.io/), [Reaction Commerce](https://docs.reactioncommerce.com/), [Plus (ThinkSNS+)](https://slimkit.github.io) and [nteract](https://docs.nteract.io/).
+
+Thank you to the following contributors who helped with this release:
+
+- @endiliey
+- @joelmarcey
+- @yangshun
+- @apuravchauhan
+- @dballance
+- @helloworld
+- @jreese
+- @machikoyasuda
+- @medz
+- @mikalai-silivonik
+- @miralemd
+- @monkeywithacupcake
+- @parano
+- @patapizza
+- @shaform
+- @steevehook
+- @theletterf
+- @tom-auger
+- @willingc
+
+**Added**
+- Add autoprefixing to CSS pipeline [\#867](https://github.com/facebook/Docusaurus/pull/867)
+- Support `text` language for code block style without any highlighting [\#875](https://github.com/facebook/Docusaurus/pull/875)
+
+**Fixed/Changed**
+- Fix wrong CSS language prefix for fenced blocks [\#842](https://github.com/facebook/Docusaurus/pull/842) [\#870](https://github.com/facebook/Docusaurus/pull/870) 
+- Fix phrase emphasis not italicized [\#850](https://github.com/facebook/Docusaurus/pull/850)
+- Don't replace static assets linking in fenced code blocks [\#864](https://github.com/facebook/Docusaurus/pull/864)
+- Blogpost summary for blog feed is now properly truncated [\#880](https://github.com/facebook/Docusaurus/pull/880)
+- Fix failure to copy static image if image compression fail [\#887](https://github.com/facebook/Docusaurus/pull/887)
+- Fix: correct docs linking for custom `defaultVersionShown` [\#894](https://github.com/facebook/Docusaurus/pull/894)
+- Fix incorrect sitemap url for non default baseUrl [\#902](https://github.com/facebook/Docusaurus/pull/902)
+- Stricter `css/main.css` routing on development server [\#904](https://github.com/facebook/Docusaurus/pull/904)
+- Fix console error when onPageNav !== 'separate' [\#909](https://github.com/facebook/Docusaurus/pull/909)
+
+**Docs**
+- Add documentation regarding usage of nested docs/ subdirectory [\#860](https://github.com/facebook/Docusaurus/pull/860)
+- Improve baseUrl documentation with an example [\#863](https://github.com/facebook/Docusaurus/pull/863)
+- Fix Table of contents documentation typo [\#873](https://github.com/facebook/Docusaurus/pull/873)
+- Update installation doc [\#888](https://github.com/facebook/Docusaurus/pull/888) [\#900](https://github.com/facebook/Docusaurus/pull/900)
+- Update guides-translations.md for CircleCI 2.0 [92f95d](https://github.com/facebook/Docusaurus/commit/92f95df934ab4034c49d66cd82ad5dbbcdee508d)
+
+
+**Chore and Maintenance**
+- Add ESLint [\#836](https://github.com/facebook/Docusaurus/pull/836) [\#837](https://github.com/facebook/Docusaurus/pull/837) [\#841](https://github.com/facebook/Docusaurus/pull/841) [\#846](https://github.com/facebook/Docusaurus/pull/846)
+- Refactor & add more tests for Docusaurus [\#839](https://github.com/facebook/Docusaurus/pull/839) [\#847](https://github.com/facebook/Docusaurus/pull/847) [\#854](https://github.com/facebook/Docusaurus/pull/854) [\#856](https://github.com/facebook/Docusaurus/pull/856)
+- Docusaurus own search will now search the docs in the correct language & version [\#859](https://github.com/facebook/Docusaurus/pull/859)
+- Improve readme [\#866](https://github.com/facebook/Docusaurus/pull/866) 
+- Add prerelease script for Docusaurus [\#876](https://github.com/facebook/Docusaurus/pull/876)
+- Remove unused files [\#881](https://github.com/facebook/Docusaurus/pull/881)
+- Update code of conduct [3c1363d](https://github.com/facebook/Docusaurus/commit/3c1363da1bd445029d7034b0575f69a7077321c3)
+- Update jest to v23 [\#885](https://github.com/facebook/Docusaurus/pull/885)
+- Activating Open Collective [\#883](https://github.com/facebook/Docusaurus/pull/883)
+- Fix Jest tests that fail on Windows [\#896](https://github.com/facebook/Docusaurus/pull/896)
+- Rename Sonar to Flipper [\#905](https://github.com/facebook/Docusaurus/pull/905)
+
+
 ## [1.3.2] - 2018-07-06
 
 This version mainly includes bug fixes found in 1.3.1 that improves stability and UX improvements.

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Code of Conduct
 
-Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.facebook.com/pages/876921332402685/open-source-code-of-conduct) so that you can understand what actions will and will not be tolerated.
+Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.fb.com/codeofconduct/) so that you can understand what actions will and will not be tolerated.

README.md

@@ -1,10 +1,10 @@
 <h1 align="center">
   <p align="center">Docusaurus</p>
-  <a href="https://docusaurus.io"><img src="/website/static/img/slash-introducing.png" alt="Docusaurus"></a>
+  <a href="https://docusaurus.io"><img src="/website/static/img/slash-introducing.svg" alt="Docusaurus"></a>
 </h1>
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/docusaurus"><img src="https://img.shields.io/npm/v/docusaurus.svg?style=flat" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/docusaurus"><a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/sponsors/badge.svg" /></a> <img src="https://img.shields.io/npm/v/docusaurus.svg?style=flat" alt="npm version"></a>
   <a href="https://circleci.com/gh/facebook/Docusaurus"><img src="https://circleci.com/gh/facebook/Docusaurus.svg?style=shield" alt="CircleCI Status"></a>
   <a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
   <a href="https://discord.gg/docusaurus"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a>
@@ -52,6 +52,36 @@ We have a few channels for contact:
 - [@docusaurus](https://twitter.com/docusaurus) on Twitter
 - [GitHub Issues](https://github.com/facebook/docusaurus/issues)
 
+## Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+<a href="https://github.com/facebook/Docusaurus/graphs/contributors"><img src="https://opencollective.com/Docusaurus/contributors.svg?width=890&button=false" /></a>
+
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/Docusaurus#backer)]
+
+<a href="https://opencollective.com/Docusaurus#backers" target="_blank"><img src="https://opencollective.com/Docusaurus/backers.svg?width=890"></a>
+
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/Docusaurus#sponsor)]
+
+<a href="https://opencollective.com/Docusaurus/sponsor/0/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/1/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/2/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/3/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/4/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/5/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/6/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/7/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/8/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/Docusaurus/sponsor/9/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/9/avatar.svg"></a>
+
+
+
 ## License
 
 Docusaurus is [MIT licensed](./LICENSE).

admin/prerelease.md

@@ -0,0 +1,27 @@
+# Prereleasing New Version of Docusaurus
+
+![demo](http://res.cloudinary.com/rengorum/image/upload/v1533297353/demo.gif)
+
+# Steps
+
+1. Ensure that `origin` remote is your Docusaurus fork and `upstream` is Docusaurus original repository. 
+
+```bash
+$ git remote -v
+origin	https://github.com/endiliey/Docusaurus.git (fetch)
+origin	https://github.com/endiliey/Docusaurus.git (push)
+upstream    https://github.com/facebook/Docusaurus.git (fetch)
+upstream    https://github.com/facebook/Docusaurus.git (push)
+```
+
+2. Pull latest changes from Docusaurus repository.
+
+```bash
+$ git fetch upstream && git checkout master && git merge upstream/master
+```
+
+2. Modify `CHANGELOG.md` and other necessary files. Do not commit the changes.
+3. Run `bash scripts/prerelease.sh`.
+4. Create your pull request on GitHub.
+
+<img width="629" alt="pull request" src="https://user-images.githubusercontent.com/17883920/43393765-ccb050ac-942a-11e8-94e8-d585034fa064.PNG">

docs/api-site-config.md

@@ -98,6 +98,8 @@ customDocsPath: 'website-docs';
 
 `editUrl` - URL for editing docs, usage example: `editUrl + 'en/doc1.md'`. If this field is omitted, there will be no "Edit this Doc" button for each document.
 
+`enableUpdateTime` - An option to enable the docs showing last update time. Set to `true` to show a line at the bottom right corner of each doc page as `Last Updated: dd/mm/yyyy hh:MM:ss Z`.
+
 `facebookAppId` - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a [Facebook application id](https://www.facebook.com/help/audiencenetwork/804209223039296).
 
 `facebookComments` - Set this to `true` if you want to enable Facebook comments at the bottom of your blog post. `facebookAppId` has to be also set.

docs/getting-started-installation.md

@@ -3,14 +3,25 @@ id: installation
 title: 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:
+Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. 
+
+## Installing 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.
 
     > You have to be on Node >= 8.x and Yarn >= 1.5.
 
-1.  Go into the root of your GitHub repo directory where you will be creating the docs.
-1.  `npx docusaurus-init`
+1.  Create a project, if none exists, and change your the directory to this project's root.
+
+    You will be creating the docs in this directory. The root directory may
+    contain other files. The Docusaurus installation script will create two new
+    directories: `docs-examples-from-docusaurus` and `website`.
+
+    > Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.
+
+1.  Run the Docusaurus installation script: `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`.
 
@@ -42,13 +53,21 @@ root-directory
     └── static
 ```
 
-Running the Docusaurus initialization script, `docusaurus-init`, produces a runnable, example website to base your site upon.
+## Running the example website
+
+After running the Docusaurus initialization script, `docusaurus-init` as
+described in the [Installation](#installing-docusaurus) section, you will have a
+runnable, example website to use as your site's base. To run:
 
 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. There's also a LiveReload server running and any changes made to the docs and files in the `website` directory will cause the page to refresh.
+1.  From within the `website` directory, run the local webserver using 
+    `yarn start` or `npm start`.
+1.  Load the example site at http://localhost:3000 if it did not already open
+    automatically.
+
+    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the `website` directory will cause the page to refresh.
 
 ![](/img/getting-started-preparation-verify.png)
 
@@ -63,7 +82,7 @@ yarn start (or npm run start)
 
 ## Updating Your Docusaurus Version
 
-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`. 
+At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the `website` directory and typing `yarn outdated docusaurus` or `npm outdated docusaurus`. 
 
 You will see something like this:
 

docs/getting-started-preparation.md

@@ -33,15 +33,31 @@ root-directory
     └── 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).
+> You may have already renamed the example blog (`website/blog-examples-from-docusaurus` to `website/blog`) and document (`docs-examples-from-docusaurus` to `docs`) 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` directory contains examples of blog posts written in markdown.
-* The `docs-examples-from-docusaurus` directory contains example documentation files written in markdown.
-* The `website/pages` directory contains example top-level pages for the site.
-* The `website/static` directory contains static assets used by the example site.
-* The `website/siteConfig.js` file is the main configuration file used by Docusaurus.
+### Directory Descriptions
 
-You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish.
+* **Documentation Source Files**: The `docs-examples-from-docusaurus` directory
+  contains example documentation files written in Markdown.
+* **Blog**: The `website/blog-examples-from-docusaurus` directory contains examples of blog posts written in markdown.
+* **Pages**: The `website/pages` directory contains example top-level pages for the site.
+* **Static files and images**: The `website/static` directory contains static assets used by the example site.
 
-You should keep the `website/pages` and `website/static` directories, 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`.
+### Key Files
+
+* **Footer**: 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.
+* **Configuration file**: The `website/siteConfig.js` file is the main
+  configuration file used by Docusaurus. 
+* **Sidebars**: The `sidebars.json` file contains the structure and ordering
+  of the documentation files.
+
+## Preparation Notes
+
+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` directories, 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`.