Commit Graph

10 Commits

Author SHA1 Message Date
Joshua Lochner 19daf2d3c1
Add jsDelivr stats to README (#395) 2023-11-18 12:59:15 +02:00
Joshua Lochner 0efa60ffff
Do not post-process `<` and `>` symbols generated from docs (#335)
* Do not post-process `<` and `>` symbols generated from docs

* Fix typo
2023-10-04 15:43:35 +02:00
Joshua Lochner f61cc66e0e Fix link to API reference 2023-08-22 17:19:49 +02:00
Joshua Lochner 27d7ea489b
Improvements to documentation (#172)
* link to the conversion Space for maximum simplicity

* add some types to script (very optional)

* typo

* no need for trailing slash here

* Node is also a valid option

* Document how to find a compatible checkpoint on the hub

* Update README

* Fix typing

* Update docs index

---------

Co-authored-by: Julien Chaumond <julien@huggingface.co>
2023-06-29 19:32:17 +02:00
Joshua Lochner 0ecf9606be
Post-process jsdoc2md marker links (#120)
* Post-process jsdoc2md marker links

* Add `group` class to certain anchor tags
2023-06-05 17:17:21 +02:00
Joshua Lochner 9640a36dc7 Update README 2023-05-15 14:35:49 +02:00
Joshua Lochner dff2b3bf56 [docs] Move snippets out of source folder 2023-05-15 10:57:59 +02:00
Joshua Lochner f285691b0c Add JSDoc config file
GitHub actions places files in a folder called `__w`, which causes JSDoc to ignore all source files.

See https://github.com/jsdoc2md/jsdoc-to-markdown/issues/137
2023-05-13 22:39:36 +02:00
Joshua Lochner 4aec9dd4f7 Use relative path for doc generation
This means the script must be run from the project's root folder
2023-05-13 22:12:01 +02:00
Joshua Lochner a73e8559b8 Add docs folder 2023-05-13 19:59:18 +02:00