Skip to content

Commit 8f38fd8

Browse files
committed
Change readme format
1 parent 9a21954 commit 8f38fd8

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ API Documentation
104104
--------------------------
105105
All code is written in TypeScript which can be self-explanatory.
106106

107-
## Writers
107+
### Writers
108108

109-
### [JSONCommentWriterBase](src/jsonCommentWriterBase.ts)
109+
#### [JSONCommentWriterBase](src/jsonCommentWriterBase.ts)
110110

111111
The abstract base class of all writers.
112112

@@ -141,7 +141,7 @@ The abstract base class of all writers.
141141
* JSON stringify implementation is based on the following code: https://github.com/douglascrockford/JSON-js/blob/2a76286e00cdc1e98fbc9e9ec6589563a3a4c3bb/json2.js
142142

143143

144-
### [CustomCommentWriter](src/customCommentWriter.ts)
144+
#### [CustomCommentWriter](src/customCommentWriter.ts)
145145

146146
A class of JSON comment writer which supports custom comments for fields specified by path.
147147

@@ -160,7 +160,7 @@ A class of JSON comment writer which supports custom comments for fields specifi
160160

161161
Comments to be shown when the selector matches.
162162

163-
### [SchemaMetadataWriter](src/schemaMetadataWriter.ts)
163+
#### [SchemaMetadataWriter](src/schemaMetadataWriter.ts)
164164

165165
A class of JSON comment writer generating comments for fields specified in JSON schema.
166166

@@ -182,9 +182,9 @@ A class of JSON comment writer generating comments for fields specified in JSON
182182

183183
Please refer to the constructor of [JSONCommentWriterBase](#JSONCommentWriterBase).
184184

185-
## Interfaces
185+
### Interfaces
186186

187-
### [IJSONComment](src/types.ts)
187+
#### [IJSONComment](src/types.ts)
188188

189189
Represents a single comment.
190190

0 commit comments

Comments
 (0)