Skip to content

Commit 6f22a32

Browse files
authored
Merge pull request #8 from paywteam/documentation
doc: lower the heading level
2 parents 5cf6410 + c2f0f94 commit 6f22a32

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="https://user-images.githubusercontent.com/19797697/79691571-5ffa4380-829b-11ea-8b93-6729ca5245c5.png" width="400" />
33
</p>
44

5-
# Prerequisites
5+
## Prerequisites
66

77
**Node.js >= 13**
88

@@ -12,14 +12,14 @@
1212
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
1313
- [sort-imports](https://marketplace.visualstudio.com/items?itemName=amatiasq.sort-imports)
1414

15-
# Dev
15+
## Dev
1616

1717
```zsh
1818
> npm install
1919
> npm run dev
2020
```
2121

22-
# Branches
22+
## Branches
2323

2424
**`master`**
2525

@@ -31,13 +31,13 @@ After heavily tested the master branch, tag and release using SemVer.
3131

3232
> For more information creating branches, read the [PAYW Contributing Guidelines](https://github.com/paywteam/contributing-guidelines#git-branch-names).
3333
34-
# Development Guides
34+
## Development Guides
3535

3636
- [Pages](#Pages)
3737
- [Components](#Components)
3838
- [Sass](#Sass)
3939

40-
## Pages
40+
### Pages
4141

4242
Next.js gracefully generates routes based on the files/directories structure inside the `pages`. It is much easier to manage and visualize them and reduces overheads configuring the routes. You can write a page component just like the other normal React components.
4343

@@ -107,15 +107,15 @@ Share the same props type if a page receives some data from server side.
107107
+ }
108108
```
109109

110-
### VSCode Snippet
110+
**VSCode Snippet**
111111

112112
We prepare a simple snippet for creating a new page component.
113113

114114
- `page`
115115

116116
<img src="https://user-images.githubusercontent.com/19797697/79678474-f9dbd500-8236-11ea-8118-fa5105a9eea9.gif" width="500" />
117117

118-
## Components
118+
### Components
119119

120120
Basically components are structured like below.
121121

@@ -176,7 +176,7 @@ What is worse, in terms of refactoring, there are many namespaces you have to mo
176176

177177
We strongly follow the principles of **Single source of truth** and **DRY(Don't Repeat Yourself)**.
178178

179-
### VSCode Snippet
179+
**VSCode Snippets**
180180

181181
Alongside a page snippet, we also prepare a snippet for creating a new React component.
182182

@@ -208,7 +208,7 @@ components
208208

209209
> If one of the child components are imported from the components other than its **_parent_**, it should not placed under the **_parent_**.
210210
211-
### Class Name
211+
**Class Name**
212212

213213
Name the mostly outer element's class with `component-{component-name}`.
214214

0 commit comments

Comments
 (0)