FooSoft / anki-connect

Anki plugin to expose a remote API for creating flash cards.
https://foosoft.net/projects/anki-connect/
Other
1.92k stars 218 forks source link

Reformat README to be more readable #373

Closed Aquafina-water-bottle closed 1 year ago

Aquafina-water-bottle commented 1 year ago

This PR reformats the README to simply do the following:

To see how the changes look in action, click here.

I personally find the documentation in the README difficult to read due to the amount of vertical scrolling I have to do, and it seems like it will only get worse as the API expands. Hiding the sample requests and results prevents a lot of extra scrolling, and allows the user to read the actual documentation behind the API easier. Additionally, moving the action names to a h4 title has the added benefit of being able to permalink to any specific action.

Some notes:

As with all stylistic changes, there are bound to be differing opinions, so I would love to hear any feedback!

FooSoft commented 1 year ago

Ooh! I like this. The markup probably won't look this good initially to start foosoft.net, but I have no problems styling it :)