diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index c4f3db4..b467614 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,5 +1,7 @@ # Documentation for malle +# DEPRECATED, replaced by typedoc + Note: you can use this library in a typescript or javascript project. When in typescript, import the interfaces to have strong typing everywhere. ~~~javascript diff --git a/README.md b/README.md index 7f17759..973a0cf 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ In this example, when a user clicks on an element with `data-malleable='true'`, Head to the [Demo](https://deltablot.github.io/malle/) to see more examples. -See the [Documentation](./DOCUMENTATION.md) for usage and available options. +See the [API Documentation](https://deltablot.github.io/malle/api) for usage and available options. ## Maintenance status diff --git a/demo/index.html b/demo/index.html index 01cc3b5..783fd21 100644 --- a/demo/index.html +++ b/demo/index.html @@ -16,6 +16,8 @@

malle demo page

+

API documentation

+

If you are looking for the complete API documentation, with all possible options and interfaces with their description, it is available here: full API documentation.

Minimal example

The text in bold is malleable. Try clicking on it.

Selecting input type