Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/inkdropapp/inkdrop-embed

Embed external contents in a note
https://github.com/inkdropapp/inkdrop-embed

Last synced: 20 days ago
JSON representation

Embed external contents in a note

Host: GitHub
URL: https://github.com/inkdropapp/inkdrop-embed
Owner: inkdropapp
License: mit
Created: 2020-01-06T06:03:48.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-06-12T01:18:36.000Z (7 months ago)
Last Synced: 2024-06-12T08:42:11.366Z (7 months ago)
Language: JavaScript
Homepage: https://www.inkdrop.app/
Size: 2.11 MB
Stars: 6
Watchers: 4
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README-mobile.md
- License: LICENSE.md

Awesome Lists containing this project

README

Allows Inkdrop to embed external contents to a note.

Note that printing and exporting are not supported since external contents are loaded asynchronously.

![](https://github.com/inkdropapp/inkdrop-embed/raw/master/docs/screenshot.png)

## How to use

Write a link with "embed" caption like so:

```markdown
[embed](https://twitter.com/inkdrop_app/status/1209029200989941760)
```

Or just write a URL:

```markdown
https://twitter.com/inkdrop_app/status/1209029200989941760
```

Links with a caption not starting with 'embed' will be rendered as regular link.

## Supported contents

- [Gist](https://gist.github.com/)
- [Twitter](https://twitter.com/)
- [YouTube](https://www.youtube.com/)

PR will be welcomed for supporting other platforms.
See [the existing implementations here](https://github.com/inkdropapp/inkdrop-embed/tree/master/src/providers).
See also [inkdrop embed provider](https://github.com/inkdropapp/inkdrop-embed-provider) if you need a static webpage for loading external scripts inside an iframe.

## Limitations

- You can't search embedded contents with keywords
- Printing and exporting not supported as they are loaded asynchronously