Skip to content
This repository was archived by the owner on Jun 11, 2022. It is now read-only.

Commit 30dbbc3

Browse files
authored
📚 improve readability with higher-level headers
1 parent 5e958d7 commit 30dbbc3

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ The default `static.json`, if it does not exist in the repo, is:
111111
{ "root": "build/" }
112112
```
113113

114-
#### Routing clean URLs
114+
### Routing clean URLs
115115

116116
By default, [React Router](https://github.com/reactjs/react-router) (not included) uses hash-based URLs like `https://example.com/index.html#/users/me/edit`. This is nice & easy when getting started with local development, but for a public app you probably want real URLs like `https://example.com/users/me/edit`.
117117

@@ -127,7 +127,7 @@ Create a `static.json` file to configure the web server for clean [`browserHisto
127127
}
128128
```
129129

130-
#### HTTPS-only
130+
### HTTPS-only
131131

132132
Enforce secure connections by automatically redirecting insecure requests to **https://**, in `static.json`:
133133

@@ -157,13 +157,13 @@ Prevent downgrade attacks with [HTTP strict transport security](https://develope
157157

158158
🤐 *Be careful not to export secrets. These values may be accessed by anyone who can see the React app.*
159159

160-
##### [Set vars on Heroku](https://devcenter.heroku.com/articles/config-vars)
160+
### [Set vars on Heroku](https://devcenter.heroku.com/articles/config-vars)
161161

162162
```bash
163163
heroku config:set REACT_APP_HELLO='I love sushi!'
164164
```
165165

166-
##### Set vars for local dev
166+
### Set vars for local dev
167167

168168
*Requires at least create-react-app 0.7. Earlier versions only support Compile-time.*
169169

@@ -174,7 +174,7 @@ REACT_APP_API_URL=http://api.example.com
174174
REACT_APP_CLIENT_ID=XyzxYzxyZ
175175
```
176176

177-
#### Compile-time vs Runtime
177+
### Compile-time vs Runtime
178178

179179
Two versions of variables are supported. In addition to compile-time variables applied during [build](https://github.com/facebookincubator/create-react-app#npm-run-build) the app supports variables set at runtime, applied as each web dyno starts-up.
180180

@@ -189,7 +189,7 @@ ex: `REACT_APP_DEBUG_ASSERTIONS` ([prune code from bundle](https://webpack.githu
189189
ex: `REACT_APP_API_URL` (transient, external reference) | | ✓
190190
ex: `REACT_APP_FILEPICKER_API_KEY` ([Add-on config vars](#add-on-config-vars)) | | ✓
191191

192-
#### Compile-time configuration
192+
### Compile-time configuration
193193

194194
♻️ The app must be re-deployed for compiled changes to take effect.
195195

@@ -200,7 +200,7 @@ git commit --allow-empty -m "Set REACT_APP_HELLO config var"
200200
git push heroku master
201201
```
202202

203-
#### Runtime configuration
203+
### Runtime configuration
204204

205205
*Requires at least create-react-app 0.7.*
206206

@@ -231,7 +231,7 @@ class App extends Component {
231231

232232
⚠️ *Avoid setting backslash escape sequences, such as `\n`, into Runtime config vars. Use literal UTF-8 values only; they will be automatically escaped.*
233233

234-
#### Add-on config vars
234+
### Add-on config vars
235235

236236
🤐 *Be careful not to export secrets. These values may be accessed by anyone who can see the React app.*
237237

0 commit comments

Comments
 (0)