Skip to content

Commit 4e3ec3e

Browse files
committed
docs(*): fix markdown titles
1 parent 0d682c3 commit 4e3ec3e

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ To **read further** about this project and its evolution:
5757

5858
**[ONLINE DEMO](https://topheman.github.io/react-es6-redux/)**
5959

60-
###Setup
60+
### Setup
6161

6262
This project now follows the same development workflow as the one explained in [topheman/webpack-babel-starter](https://github.com/topheman/webpack-babel-starter) (with some additions, specific to the project).
6363

64-
####Install
64+
#### Install
6565

6666
```shell
6767
git clone https://github.com/topheman/react-es6-redux.git
@@ -71,24 +71,24 @@ npm install
7171

7272
*Note:* Installing the [topheman-apis-proxy](#with-topheman-apis-proxy) backend is **no longer mandatory** (I changed the code so that you could do unauthenticated request to the github API - you will be [rate limited to 10 requests per minute](https://developer.github.com/v3/search/#rate-limit) though).
7373

74-
####Run
74+
#### Run
7575

76-
#####Dev mode
76+
##### Dev mode
7777

7878
* `npm start`
7979
* Open [http://localhost:8080/](http://localhost:8080/)
8080

8181
You're good to go with hot-reload / redux-devtools / time-travel / sourcemaps ...!
8282

83-
#####Mock mode
83+
##### Mock mode
8484

8585
You can also run the app in mock mode (useful for tests):
8686

8787
* `npm run webpack-mock`
8888
* Open [http://localhost:8080/](http://localhost:8080/)
8989

9090

91-
####Build
91+
#### Build
9292

9393
At the root of the project :
9494

@@ -100,9 +100,9 @@ A `/build/dist` folder will be created with your project built in it.
100100

101101
You can run it with `npm run serve-build`
102102

103-
####Test
103+
#### Test
104104

105-
#####Unit tests
105+
##### Unit tests
106106

107107
`npm test` will launch:
108108

@@ -116,7 +116,7 @@ If you wish to generate coverage reports, just `npm run karma-coverage` (those r
116116

117117
*Note:* Unit-tests are run through karma in PhantomJS (the `webpack.config.js` being injected), they can also be run directly via mocha ([see wiki](https://github.com/topheman/react-es6-redux/wiki/Advanced-tasks#test-tasks)).
118118

119-
#####End to end tests
119+
##### End to end tests
120120

121121
e2e tests are located in `/test/e2e/spec`.
122122

@@ -127,14 +127,14 @@ Open two terminal tabs, on each one:
127127

128128
Those tests are run on Travis CI, via [SauceLabs](https://saucelabs.com/u/react-es6-redux).
129129

130-
####Linter
130+
#### Linter
131131

132132
I'm using eslint, based on [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb), a preset for `.eslintrc` configuration. For more infos, checkout the release it was implemented: [v2.5.0](https://github.com/topheman/react-es6-redux/releases/tag/v2.5.0).
133133

134134
* `npm run lint`: single run linting of `/src` & `/test` folders
135135
* `npm run lint-watch`: same in watch mode
136136

137-
####Specific commands
137+
#### Specific commands
138138

139139
You may want some granularity, the `DEVTOOLS`, `SHOW_DEVTOOLS`, `NODE_ENV` & `LINTER` variables are at your disposal:
140140

@@ -147,7 +147,7 @@ You may want some granularity, the `DEVTOOLS`, `SHOW_DEVTOOLS`, `NODE_ENV` & `LI
147147

148148
**Read the ["Advanced tasks" wiki section](https://github.com/topheman/react-es6-redux/wiki/Advanced-tasks) for more infos ...**
149149

150-
####With topheman-apis-proxy
150+
#### With topheman-apis-proxy
151151

152152
**This part is optional**
153153

@@ -159,17 +159,17 @@ Then your workflow will be:
159159
* Open a terminal in the topheman-apis-proxy folder and `grunt serve` (see more in the [run in local](https://github.com/topheman/topheman-apis-proxy#run-in-local) README section)
160160
* Go to [http://localhost:8080/](http://localhost:8080/)
161161

162-
###Deploy
162+
### Deploy
163163

164164
I'm using github pages for hosting (free https, easy deploy via git - a good deal since I don't need any server-side logic). You'll find a [gh-pages orphan branch](https://github.com/topheman/react-es6-redux/tree/gh-pages) where the deployed builds are stored.
165165

166166
My deployment routine is described on the [topheman/webpack-babel-starter Wiki](https://github.com/topheman/webpack-babel-starter/wiki).
167167

168-
###Notes
168+
### Notes
169169

170170
* `build-prod-all-owner`: build task for [topheman.github.io/react-es6-redux](https://topheman.github.io/react-es6-redux/)
171171

172-
###License
172+
### License
173173

174174
This software is distributed under an MIT licence.
175175

bin/README.dist.template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
##react-es6-redux - distribution version (gh-pages branch)
1+
## react-es6-redux - distribution version (gh-pages branch)
22

33
This is the distribution version of [topheman/react-es6-redux](https://github.com/topheman/react-es6-redux) - v<%= pkg.version %><% if (urlToCommit !== null) { %> - [#<%= gitRevisionShort %>](<%= urlToCommit %>)<% } %>.
44

55
**Warning**: This is the **generated** code, versionned on the `gh-pages` branch, testable online [here](https://topheman.github.io/react-es6-redux/). If you wish to see the original source code, switch to the [master branch](https://github.com/topheman/react-es6-redux).
66

7-
###Infos:
7+
### Infos:
88

99
Those informations are available on the [topheman/webpack-babel-starter](https://github.com/topheman/webpack-babel-starter) project:
1010

0 commit comments

Comments
 (0)