docsify-link-preview

Link preview for docsify

Usage no npm install needed!

<script type="module">
  import docsifyLinkPreview from 'https://cdn.skypack.dev/docsify-link-preview';
</script>

README

docsify-link-preview

docsify-link-preview
a plugin to render link previews in docsify

💾 Install

  1. Get your API key from https://www.linkpreview.net/

  2. Configure

    <script>
  window.$docsify = {
    linkpreview: {
      key: "YOUR_API_KEY",
    },
  };
</script>

  3. Insert script into docsify document:

    <script src="//unpkg.com/docsify-link-preview/src/index.js"></script>

  4. Insert the style

    <link
  rel="stylesheet"
  href="//unpkg.com/docsify-link-preview/src/style.css"
/>

🎮 Usage

When you want to render a preview just put your link into a:

```link-preview
link.com
```

🔥 Example

👤 Contributing

  1. 🔀 FORK IT
  2. Create your feature branch git checkout -b feature/branch
  3. Commit your changes git commit -am 'Add some fooBar'
  4. Push to the branch git push origin feature/branch
  5. Create a new Pull Request
  6. 🙏 Thank you

💼 License

Copyright © 2020 - present, Puria Nafisi Azizi <puria@dyne.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🔝 back to top