diff --git a/CHANGELOG.md b/CHANGELOG.md index d37aafccb0..ea10087f5c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,21 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ## [Unreleased] +## [1.1.4] - 2018-05-25 + +Yet another hotfix release. We found an issue with the way we did LiveReload - we were watching the `node_modules` directory and that caused some users to encounter errors. We stopped watching `node_modules` directory in `gaze`. + +Thank you to the following contributors who helped with this release: + +- @artiebits +- @yangshun + +### Fixed/Changed + +- If you already have a tab with the Docusaurus website open, restarting the server will [not open a new browser tab](https://github.com/facebook/Docusaurus/commit/407636a4d92b23fe59c31bbc58a0e3416d91f01f). +- Updated [directory tree display](https://github.com/facebook/Docusaurus/commit/454e3d359f786069f83a5bfe2687e304f1f0547f) for a newly-generated site. +- [Don't watch `node_modules`](https://github.com/facebook/Docusaurus/commit/b5fd7bae738ac14d702e80bd3764fee94e0a8e93) in dev server mode. + ## [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. @@ -441,7 +456,8 @@ N/A - Blog - Documentation -[Unreleased]: https://github.com/facebook/Docusaurus/compare/v1.1.3...HEAD +[Unreleased]: https://github.com/facebook/Docusaurus/compare/v1.1.4...HEAD +[1.1.4]: https://github.com/facebook/Docusaurus/compare/v1.1.3...v1.1.4 [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 diff --git a/admin/publish.md b/admin/publish.md index 62c635d140..85b7c711be 100644 --- a/admin/publish.md +++ b/admin/publish.md @@ -12,7 +12,7 @@ If you are not currently logged into npm locally: ## 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. Update the [changelog](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` diff --git a/package.json b/package.json index ca49bf4e0d..ac0ce7a66e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus", "description": "Easy to Maintain Open Source Documentation Websites", - "version": "1.1.3", + "version": "1.1.4", "license": "MIT", "keywords": [ "documentation", diff --git a/website/versioned_docs/version-1.1.4/getting-started-installation.md b/website/versioned_docs/version-1.1.4/getting-started-installation.md new file mode 100644 index 0000000000..f48c117b51 --- /dev/null +++ b/website/versioned_docs/version-1.1.4/getting-started-installation.md @@ -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) +``` diff --git a/website/versioned_docs/version-1.1.4/getting-started-preparation.md b/website/versioned_docs/version-1.1.4/getting-started-preparation.md new file mode 100644 index 0000000000..6764202775 --- /dev/null +++ b/website/versioned_docs/version-1.1.4/getting-started-preparation.md @@ -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`. diff --git a/website/versions.json b/website/versions.json index 1ef53bac95..a5fa506865 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1,4 +1,5 @@ [ + "1.1.4", "1.1.3", "1.1.2", "1.1.1",