Skip to content

Commit 0b06f15

Browse files
committed
doc: fix alignment issues
1 parent 808818d commit 0b06f15

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,16 +141,21 @@ 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+
144145
1. Clone this project
145146
```
146147
git clone https://github.com/Hashnode/mern-starter
147148
```
149+
148150
2. Make your changes. Add a package, add authentication, modify the file structure, replace Redux with MobX or anything else.
151+
149152
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.
153+
150154
4. Next clone `mern-cli` project
151155
```
152156
git clone https://github.com/Hashnode/mern-cli
153157
```
158+
154159
5. Add your project details to `variants.json` in the cloned project and send a pull request.
155160
156161
### Modifying Generators
@@ -172,12 +177,17 @@ It contains a blueprints array. Each object in it is the config for a generator.
172177
```
173178
174179
A file object contains
180+
175181
1. `blueprint-path` - location of the blueprint file
182+
176183
2. `target-path` - location where the file should be generated
184+
177185
3. `parent-path` - optional parameter, used if you want to generate the file inside an already existing folder in your project.
178186
179-
`target-path` supports [ejs](https://github.com/mde/ejs) and the following variables will be passed while rendering,
187+
Also, `target-path` supports [ejs](https://github.com/mde/ejs) and the following variables will be passed while rendering,
188+
180189
1. `name` - `<component-name>` input from user
190+
181191
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,
182192
```
183193
{
@@ -194,6 +204,7 @@ A file object contains
194204
}
195205
```
196206
Here, notice the usage. In `<module-name>/<component-name>`, `<module-name>` will be passed as `parent` and `<component-name>` will be passed as `<name>`.
207+
197208
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).
198209
199210
#### Blueprint files

0 commit comments

Comments
 (0)