Skip to content

Commit 808818d

Browse files
committed
doc: fix md numbered lists
1 parent ad68cf7 commit 808818d

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -141,17 +141,17 @@ We use babel to transpile code in both server and client with `stage-0` plugin.
141141

142142
### Make your MERN
143143
In this version, we enabled the `mern-cli` to clone not only this project but also the variants of `mern-starter` like one project with MaterialUI or JWT auth. To make your version of MERN, follow these steps
144-
1) Clone this project
144+
1. Clone this project
145145
```
146146
git clone https://github.com/Hashnode/mern-starter
147147
```
148-
2) Make your changes. Add a package, add authentication, modify the file structure, replace Redux with MobX or anything else.
149-
3) In this version, we also added code generators. Blueprints for those generators are located at `config/blueprints`, and config is located at `mern.json`. Make sure to edit them if necessary after your made modifications in the previous step. There is a section below which explains how to modify generators.
150-
4) Next clone `mern-cli` project
148+
2. Make your changes. Add a package, add authentication, modify the file structure, replace Redux with MobX or anything else.
149+
3. In this version, we also added code generators. Blueprints for those generators are located at `config/blueprints`, and config is located at `mern.json`. Make sure to edit them if necessary after your made modifications in the previous step. There is a section below which explains how to modify generators.
150+
4. Next clone `mern-cli` project
151151
```
152152
git clone https://github.com/Hashnode/mern-cli
153153
```
154-
5) Add your project details to `variants.json` in the cloned project and send a pull request.
154+
5. Add your project details to `variants.json` in the cloned project and send a pull request.
155155
156156
### Modifying Generators
157157
@@ -172,13 +172,13 @@ It contains a blueprints array. Each object in it is the config for a generator.
172172
```
173173
174174
A file object contains
175-
1) `blueprint-path` - location of the blueprint file
176-
2) `target-path` - location where the file should be generated
177-
3) `parent-path` - optional parameter, used if you want to generate the file inside an already existing folder in your project.
175+
1. `blueprint-path` - location of the blueprint file
176+
2. `target-path` - location where the file should be generated
177+
3. `parent-path` - optional parameter, used if you want to generate the file inside an already existing folder in your project.
178178
179179
`target-path` supports [ejs](https://github.com/mde/ejs) and the following variables will be passed while rendering,
180-
1) `name` - `<component-name>` input from user
181-
2) `parent` - in particular special cases where you need to generate files inside an already existing folder, you can obtain this parent variable from the user. A config using that will look like,
180+
1. `name` - `<component-name>` input from user
181+
2. `parent` - in particular special cases where you need to generate files inside an already existing folder, you can obtain this parent variable from the user. A config using that will look like,
182182
```
183183
{
184184
"name": "dumb-m",
@@ -194,7 +194,7 @@ A file object contains
194194
}
195195
```
196196
Here, notice the usage. In `<module-name>/<component-name>`, `<module-name>` will be passed as `parent` and `<component-name>` will be passed as `<name>`.
197-
3) `helpers` - an helper object is passed which include common utility functions. For now, it contains `capitalize`. If you want to add more, send a PR to [mern-cli](https://github.com/Hashnode/mern-cli).
197+
3. `helpers` - an helper object is passed which include common utility functions. For now, it contains `capitalize`. If you want to add more, send a PR to [mern-cli](https://github.com/Hashnode/mern-cli).
198198
199199
#### Blueprint files
200200
Blueprints are basically [ejs](https://github.com/mde/ejs) templates which are rendered with the same three variables(`name`, optional `parent` and `helpers` object) as above.

0 commit comments

Comments
 (0)