@@ -35,15 +35,21 @@ You can also add any **k:v** labels to your post, like `foo:bar`.
3535- [ Defaults] ( #defaults )
3636- [ Comments] ( #comments )
3737- [ API Reference] ( #api-reference )
38- - [ ConstructorParams] ( #constructorparams )
39- - [ QueryParams] ( #queryparams )
40- - [ PagerParams] ( #pagerparams )
41- - [ GetPostResult] ( #getpostresult )
42- - [ GetPostsResult] ( #getpostsresult )
43- - [ GetCommentsResult] ( #getcommentsresult )
44- - [ Post] ( #post )
45- - [ PostReduced] ( #postreduced )
46- - [ Comment] ( #comment )
38+ - [ Instance & Methods] ( #instance-&-methods )
39+ - [ new GithubBlog] ( #new-githubblog )
40+ - [ getPost] ( #getpost )
41+ - [ getPosts] ( #getposts )
42+ - [ getComments] ( #getcomments )
43+ - [ Types] ( #types )
44+ - [ ConstructorParams] ( #constructorparams )
45+ - [ QueryParams] ( #queryparams )
46+ - [ PagerParams] ( #pagerparams )
47+ - [ GetPostResult] ( #getpostresult )
48+ - [ GetPostsResult] ( #getpostsresult )
49+ - [ GetCommentsResult] ( #getcommentsresult )
50+ - [ Post] ( #post )
51+ - [ PostReduced] ( #postreduced )
52+ - [ Comment] ( #comment )
4753
4854##Getting Started
4955
@@ -222,16 +228,40 @@ const moreComments = await blog.getComments({
222228
223229##API Reference
224230
231+ ###Instance & Methods
232+
233+ ####new GithubBlog
234+
225235``` ts
226- const = new GithubBlog (ConstructorParams )
236+ const = new GithubBlog (ConstructorParams );
237+ ```
238+
239+ See:[ ConstructorParams] ( #constructorparams ) ;
240+
241+ ###getPost
227242
243+ ``` ts
228244blog .getPost ({ query:QueryParams }):Promise < GetPostResult >
245+ ```
246+
247+ See:[ QueryParams] ( #queryparams ) ;[ GetPostResult] ( #getpostresult ) ;
229248
249+ ###getPosts
250+
251+ ``` ts
230252blog .getPosts ({ query:QueryParams , pager:PagerParams }):Promise < GetPostsResult >
253+ ```
254+
255+ See:[ QueryParams] ( #queryparams ) ;[ PagerParams] ( #pagerparams ) ;[ GetPostsResult] ( #getpostsresult ) ;
256+
257+ ###getComments
231258
259+ ``` ts
232260blog .getComments ({ query:QueryParams , pager:PagerParams }):Promise < GetCommentsResult >
233261```
234262
263+ See:[ QueryParams] ( #queryparams ) ;[ PagerParams] ( #pagerparams ) ;[ GetCommentsResult] ( #getcommentsresult ) ;
264+
235265###Types
236266
237267####` ConstructorParams `
@@ -245,6 +275,8 @@ type ConstructorParams = {
245275};
246276```
247277
278+ See:[ QueryParams] ( #queryparams ) ;[ PagerParams] ( #pagerparams ) ;
279+
248280####` QueryParams `
249281
250282``` ts
@@ -307,6 +339,8 @@ type GetPostResult = {
307339};
308340```
309341
342+ See:[ Post] ( #post ) ;
343+
310344####` GetPostsResult `
311345
312346``` ts
@@ -325,6 +359,8 @@ type GetPostsResult = {
325359};
326360```
327361
362+ See:[ PostReduced] ( #postreduced ) ;
363+
328364####` GetCommentsResult `
329365
330366``` ts
@@ -343,6 +379,8 @@ type GetCommentsResult = {
343379};
344380```
345381
382+ See:[ Comment] ( #comment ) ;
383+
346384####` Post `
347385
348386``` ts
@@ -383,6 +421,8 @@ type Post = {
383421
384422Same as` Post ` but without` body ` .
385423
424+ See:[ Post] ( #post ) ;
425+
386426####` Comment `
387427
388428``` ts