Skip to content

Commit

Permalink
add link to api doc in readme and demo page
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasCARPi committed Mar 12, 2024
1 parent 9df679c commit 6216cb2
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

<div class='container-fluid'>
<h1>malle demo page</h1>
<h2>API documentation</h2>
<p>If you are looking for the complete API documentation, with all possible options and interfaces with their description, it is available here: <a href='/malle/api'>full API documentation</a>.</p>
<h2>Minimal example</h2>
<p>The text <span id='minimal' class='fw-bold'>in bold</span> is malleable. Try clicking on it.</p>
<h2>Selecting input type</h2>
Expand Down

0 comments on commit 6216cb2

Please sign in to comment.