diff --git a/README.md b/README.md index 2858a65b0f..2a75a4bc6b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

- npm version + npm version CircleCI Status PRs Welcome Chat @@ -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)]. + + + +## Backers + +Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/Docusaurus#backer)] + + + + +## 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)] + + + + + + + + + + + + + + ## License Docusaurus is [MIT licensed](./LICENSE). diff --git a/package.json b/package.json index 2124032da9..5ca34c50b8 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,12 @@ "description": "Easy to Maintain Open Source Documentation Websites", "version": "1.3.2", "license": "MIT", - "keywords": ["documentation", "websites", "open source", "docusaurus"], + "keywords": [ + "documentation", + "websites", + "open source", + "docusaurus" + ], "repository": { "type": "git", "url": "https://github.com/facebook/Docusaurus.git" @@ -11,24 +16,18 @@ "scripts": { "ci-check": "yarn lint && yarn prettier:diff", "format:source": "prettier --config .prettierrc --write \"lib/**/*.js\"", - "format:examples": - "prettier --config .prettierrc --write \"examples/**/*.js\"", - "format:website": - "prettier --config .prettierrc --write \"website/**/*.js\"", - "lint": - "eslint --cache \"lib/**/*.js\" \"examples/**/*.js\" \"website/**/*.js\"", - "nit:source": - "prettier --config .prettierrc --list-different \"lib/**/*.js\"", - "nit:examples": - "prettier --config .prettierrc --list-different \"examples/**/*.js\"", - "nit:website": - "prettier --config .prettierrc --list-different \"website/**/*.js\"", + "format:examples": "prettier --config .prettierrc --write \"examples/**/*.js\"", + "format:website": "prettier --config .prettierrc --write \"website/**/*.js\"", + "lint": "eslint --cache \"lib/**/*.js\" \"examples/**/*.js\" \"website/**/*.js\"", + "nit:source": "prettier --config .prettierrc --list-different \"lib/**/*.js\"", + "nit:examples": "prettier --config .prettierrc --list-different \"examples/**/*.js\"", + "nit:website": "prettier --config .prettierrc --list-different \"website/**/*.js\"", "precommit": "lint-staged", - "prettier": - "yarn format:source && yarn format:examples && yarn format:website", + "prettier": "yarn format:source && yarn format:examples && yarn format:website", "prettier:diff": "yarn nit:source && yarn nit:examples && yarn nit:website", "test": "jest", - "start": "cd website && yarn start" + "start": "cd website && yarn start", + "postinstall": "opencollective postinstall" }, "lint-staged": { "linters": { @@ -82,6 +81,7 @@ "imagemin-svgo": "^6.0.0", "markdown-toc": "^1.2.0", "mkdirp": "^0.5.1", + "opencollective": "^1.0.3", "postcss": "^7.0.1", "prismjs": "^1.15.0", "react": "^16.4.1", @@ -112,5 +112,9 @@ "lint-staged": "^7.2.0", "prettier": "^1.13.7", "rimraf": "^2.6.2" + }, + "collective": { + "type": "opencollective", + "url": "https://opencollective.com/Docusaurus" } } diff --git a/yarn.lock b/yarn.lock index 68a22090be..1e13f8f817 100644 --- a/yarn.lock +++ b/yarn.lock @@ -190,7 +190,7 @@ amdefine@>=0.0.4: version "1.0.1" resolved "https://registry.yarnpkg.com/amdefine/-/amdefine-1.0.1.tgz#4a5282ac164729e93619bcfd3ad151f817ce91f5" -ansi-escapes@^1.0.0: +ansi-escapes@^1.0.0, ansi-escapes@^1.1.0: version "1.4.0" resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-1.4.0.tgz#d3a8a83b319aa67793662b13e761c7911422306e" @@ -928,6 +928,14 @@ babel-plugin-transform-strict-mode@^6.24.1: babel-runtime "^6.22.0" babel-types "^6.24.1" +babel-polyfill@6.23.0: + version "6.23.0" + resolved "https://registry.yarnpkg.com/babel-polyfill/-/babel-polyfill-6.23.0.tgz#8364ca62df8eafb830499f699177466c3b03499d" + dependencies: + babel-runtime "^6.22.0" + core-js "^2.4.0" + regenerator-runtime "^0.10.0" + babel-polyfill@^6.26.0: version "6.26.0" resolved "https://registry.yarnpkg.com/babel-polyfill/-/babel-polyfill-6.26.0.tgz#379937abc67d7895970adc621f284cd966cf2153" @@ -2607,7 +2615,7 @@ extend@^3.0.0, extend@~3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.1.tgz#a755ea7bc1adfcc5a31ce7e762dbaadc5e636444" -external-editor@^2.0.4: +external-editor@^2.0.1, external-editor@^2.0.4: version "2.2.0" resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-2.2.0.tgz#045511cfd8d133f3846673d1047c154e214ad3d5" dependencies: @@ -3477,6 +3485,24 @@ ini@^1.3.4, ini@~1.3.0: version "1.3.5" resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.5.tgz#eee25f56db1c9ec6085e0c22778083f596abf927" +inquirer@3.0.6: + version "3.0.6" + resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-3.0.6.tgz#e04aaa9d05b7a3cb9b0f407d04375f0447190347" + dependencies: + ansi-escapes "^1.1.0" + chalk "^1.0.0" + cli-cursor "^2.1.0" + cli-width "^2.0.0" + external-editor "^2.0.1" + figures "^2.0.0" + lodash "^4.3.0" + mute-stream "0.0.7" + run-async "^2.2.0" + rx "^4.1.0" + string-width "^2.0.0" + strip-ansi "^3.0.0" + through "^2.3.6" + inquirer@3.3.0, inquirer@^3.0.6: version "3.3.0" resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-3.3.0.tgz#9dd2f2ad765dcab1ff0443b491442a20ba227dc9" @@ -4942,7 +4968,7 @@ minimist@0.0.8: version "0.0.8" resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.8.tgz#857fcabfc3397d2625b8228262e86aa7a011b05d" -minimist@^1.1.0, minimist@^1.1.1, minimist@^1.1.3, minimist@^1.2.0: +minimist@1.2.0, minimist@^1.1.0, minimist@^1.1.1, minimist@^1.1.3, minimist@^1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.0.tgz#a35008b20f41383eec1fb914f4cd5df79a264284" @@ -5026,6 +5052,13 @@ negotiator@0.6.1: version "0.6.1" resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.1.tgz#2b327184e8992101177b28563fb5e7102acd0ca9" +node-fetch@1.6.3: + version "1.6.3" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-1.6.3.tgz#dc234edd6489982d58e8f0db4f695029abcd8c04" + dependencies: + encoding "^0.1.11" + is-stream "^1.0.1" + node-fetch@^1.0.1: version "1.7.3" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-1.7.3.tgz#980f6f72d85211a5347c6b2bc18c5b84c3eb47ef" @@ -5271,6 +5304,24 @@ onetime@^2.0.0: dependencies: mimic-fn "^1.0.0" +opencollective@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/opencollective/-/opencollective-1.0.3.tgz#aee6372bc28144583690c3ca8daecfc120dd0ef1" + dependencies: + babel-polyfill "6.23.0" + chalk "1.1.3" + inquirer "3.0.6" + minimist "1.2.0" + node-fetch "1.6.3" + opn "4.0.2" + +opn@4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/opn/-/opn-4.0.2.tgz#7abc22e644dff63b0a96d5ab7f2790c0f01abc95" + dependencies: + object-assign "^4.0.1" + pinkie-promise "^2.0.0" + opn@5.2.0: version "5.2.0" resolved "https://registry.yarnpkg.com/opn/-/opn-5.2.0.tgz#71fdf934d6827d676cecbea1531f95d354641225" @@ -6043,7 +6094,7 @@ regenerate@^1.2.1: version "1.4.0" resolved "https://registry.yarnpkg.com/regenerate/-/regenerate-1.4.0.tgz#4a856ec4b56e4077c557589cae85e7a4c8869a11" -regenerator-runtime@^0.10.5: +regenerator-runtime@^0.10.0, regenerator-runtime@^0.10.5: version "0.10.5" resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.10.5.tgz#336c3efc1220adcedda2c9fab67b5a7955a33658" @@ -6270,6 +6321,10 @@ rx-lite@*, rx-lite@^4.0.8: version "4.0.8" resolved "https://registry.yarnpkg.com/rx-lite/-/rx-lite-4.0.8.tgz#0b1e11af8bc44836f04a6407e92da42467b79444" +rx@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/rx/-/rx-4.1.0.tgz#a5f13ff79ef3b740fe30aa803fb09f98805d4782" + rxjs@^6.1.0: version "6.2.1" resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-6.2.1.tgz#246cebec189a6cbc143a3ef9f62d6f4c91813ca1"