search

goparrot / square-connect-plus

Typescript library which extends the official Square Connect APIs library with additional functionality
MIT License
4 stars 0 forks source link

docs: add TOC #9

Closed strdr4605 closed 4 years ago

strdr4605 commented 4 years ago

This is a 🔦 documentation change.

Summary

I added TOC and links to TOC

ruscon commented 4 years ago

@strdr4605 maybe :top: ?

strdr4605 commented 4 years ago

🔝is not a Github emoji as ⬆️ which is created with :arrow_up:. A plus of using emoji direct is that link stays #simple-example and not #simple-example-arrow_up.

I solved this problem in my package by adding <a>

## API
- [mockingcase(input, [options]) ⇒ <code>string</code>](#mockingcase)

...

<a name="mockingcase"></a>

## mockingcase(input, [options]) ⇒ <code>string</code> [:arrow_up:](#api)

or it is possible to use ⬆️ directly without :arrow_up:.

The 🔝 is smaller that ⬆️ and not so visible (IMNO). See demo.