mirror of
https://github.com/zhigang1992/create-react-app.git
synced 2026-01-12 17:12:59 +08:00
Update links to docs in all package README files (#5912)
* Update links to docs in all package README files * Fix formatting of issue template * Fix formatting of issue template
This commit is contained in:
24
.github/ISSUE_TEMPLATE.md
vendored
24
.github/ISSUE_TEMPLATE.md
vendored
@@ -6,12 +6,13 @@
|
||||
|
||||
(write your answer here)
|
||||
|
||||
|
||||
<!--
|
||||
If you answered "Yes":
|
||||
|
||||
|
||||
Please note that your issue will be fixed much faster if you spend about
|
||||
half an hour preparing it, including the exact reproduction steps and a demo.
|
||||
|
||||
|
||||
If you're in a hurry or don't feel confident, it's fine to report bugs with
|
||||
less details, but this makes it less likely they'll get fixed soon.
|
||||
|
||||
@@ -37,14 +38,14 @@
|
||||
Then you need to decide which package manager you prefer to use.
|
||||
We support both npm (https://npmjs.com) and yarn (http://yarnpkg.com/).
|
||||
However, **they can't be used together in one project** so you need to pick one.
|
||||
|
||||
|
||||
If you decided to use npm, run this in your project directory:
|
||||
|
||||
npm install -g npm@latest
|
||||
npm install
|
||||
|
||||
This should fix your project.
|
||||
|
||||
|
||||
If you decided to use yarn, update it first (https://yarnpkg.com/en/docs/install).
|
||||
Then run in your project directory:
|
||||
|
||||
@@ -62,19 +63,20 @@
|
||||
|
||||
(Write your answer here.)
|
||||
|
||||
|
||||
### Which terms did you search for in User Guide?
|
||||
|
||||
<!--
|
||||
There are a few common documented problems, such as watcher not detecting changes, or build failing.
|
||||
They are described in the Troubleshooting section of the User Guide:
|
||||
|
||||
https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting
|
||||
https://facebook.github.io/create-react-app/docs/troubleshooting
|
||||
|
||||
Please scan these few sections for common problems.
|
||||
Additionally, you can search the User Guide itself for something you're having issues with:
|
||||
|
||||
https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md
|
||||
|
||||
|
||||
https://facebook.github.io/create-react-app/
|
||||
|
||||
If you didn't find the solution, please share which words you searched for.
|
||||
This helps us improve documentation for future readers who might encounter the same problem.
|
||||
-->
|
||||
@@ -98,6 +100,7 @@
|
||||
|
||||
(paste the output of the command here)
|
||||
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
<!--
|
||||
@@ -154,13 +157,14 @@
|
||||
|
||||
(Paste the link to an example project and exact instructions to reproduce the issue.)
|
||||
|
||||
|
||||
<!--
|
||||
What happens if you skip this step?
|
||||
|
||||
|
||||
We will try to help you, but in many cases it is impossible because crucial
|
||||
information is missing. In that case we'll tag an issue as having a low priority,
|
||||
and eventually close it if there is no clear direction.
|
||||
|
||||
|
||||
We still appreciate the report though, as eventually somebody else might
|
||||
create a reproducible example for it.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Create React App [](https://travis-ci.org/facebook/create-react-app) [](https://github.com/facebook/create-react-app/pulls)
|
||||
# Create React App [](https://travis-ci.org/facebook/create-react-app) [](https://github.com/facebook/create-react-app/pulls)
|
||||
|
||||
Create React apps with no build configuration.
|
||||
|
||||
@@ -111,7 +111,7 @@ You will see the build errors and lint warnings in the console.
|
||||
Runs the test watcher in an interactive mode.<br>
|
||||
By default, runs tests related to files changed since the last commit.
|
||||
|
||||
[Read more about testing.](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
|
||||
[Read more about testing.](https://facebook.github.io/create-react-app/docs/running-tests)
|
||||
|
||||
### `npm run build` or `yarn build`
|
||||
|
||||
@@ -153,7 +153,7 @@ Your environment will have everything you need to build a modern single-page Rea
|
||||
|
||||
Check out [this guide](https://github.com/nitishdayal/cra_closer_look) for an overview of how these tools fit together.
|
||||
|
||||
The tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can ["eject"](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject) and customize it, but then you will need to maintain this configuration.
|
||||
The tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can ["eject"](https://facebook.github.io/create-react-app/docs/available-scripts#npm-run-eject) and customize it, but then you will need to maintain this configuration.
|
||||
|
||||
## Popular Alternatives
|
||||
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
This package includes the Babel preset used by [Create React App](https://github.com/facebook/create-react-app).<br>
|
||||
Please refer to its documentation:
|
||||
|
||||
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
|
||||
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
|
||||
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
|
||||
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
|
||||
|
||||
## Usage in Create React App Projects
|
||||
|
||||
|
||||
@@ -3,5 +3,5 @@
|
||||
This package includes the global command for [Create React App](https://github.com/facebook/create-react-app).<br>
|
||||
Please refer to its documentation:
|
||||
|
||||
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
|
||||
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
|
||||
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
|
||||
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
This package includes the shareable ESLint configuration used by [Create React App](https://github.com/facebook/create-react-app).<br>
|
||||
Please refer to its documentation:
|
||||
|
||||
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
|
||||
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
|
||||
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
|
||||
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
|
||||
|
||||
## Usage in Create React App Projects
|
||||
|
||||
@@ -64,4 +64,4 @@ If you want to enable even more accessibility rules, you can create an `.eslintr
|
||||
}
|
||||
```
|
||||
|
||||
However, if you are using [Create React App](https://github.com/facebook/create-react-app) and have not ejected, any additional rules will only be displayed in the [IDE integrations](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#displaying-lint-output-in-the-editor), but not in the browser or the terminal.
|
||||
However, if you are using [Create React App](https://github.com/facebook/create-react-app) and have not ejected, any additional rules will only be displayed in the [IDE integrations](https://facebook.github.io/create-react-app/docs/setting-up-your-editor#displaying-lint-output-in-the-editor), but not in the browser or the terminal.
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
This package includes some utilities used by [Create React App](https://github.com/facebook/create-react-app).<br>
|
||||
Please refer to its documentation:
|
||||
|
||||
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
|
||||
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
|
||||
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
|
||||
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
|
||||
|
||||
## Usage in Create React App Projects
|
||||
|
||||
@@ -12,7 +12,7 @@ These utilities come by default with [Create React App](https://github.com/faceb
|
||||
|
||||
## Usage Outside of Create React App
|
||||
|
||||
If you don’t use Create React App, or if you [ejected](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject), you may keep using these utilities. Their development will be aligned with Create React App, so major versions of these utilities may come out relatively often. Feel free to fork or copy and paste them into your projects if you’d like to have more control over them, or feel free to use the old versions. Not all of them are React-specific, but we might make some of them more React-specific in the future.
|
||||
If you don’t use Create React App, or if you [ejected](https://facebook.github.io/create-react-app/docs/available-scripts#npm-run-eject), you may keep using these utilities. Their development will be aligned with Create React App, so major versions of these utilities may come out relatively often. Feel free to fork or copy and paste them into your projects if you’d like to have more control over them, or feel free to use the old versions. Not all of them are React-specific, but we might make some of them more React-specific in the future.
|
||||
|
||||
### Entry Points
|
||||
|
||||
|
||||
@@ -3,5 +3,5 @@
|
||||
This package includes scripts and configuration used by [Create React App](https://github.com/facebook/create-react-app).<br>
|
||||
Please refer to its documentation:
|
||||
|
||||
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
|
||||
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
|
||||
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
|
||||
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
|
||||
|
||||
2
packages/react-scripts/bin/react-scripts.js
vendored
2
packages/react-scripts/bin/react-scripts.js
vendored
@@ -59,7 +59,7 @@ switch (script) {
|
||||
console.log('Unknown script "' + script + '".');
|
||||
console.log('Perhaps you need to update react-scripts?');
|
||||
console.log(
|
||||
'See: https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#updating-to-new-releases'
|
||||
'See: https://facebook.github.io/create-react-app/docs/updating-to-new-releases'
|
||||
);
|
||||
break;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user