Giter VIP home page Giter VIP logo

nocomment's Introduction

nocomment

A Nostr-powered embeddable website comments widget that just works.

Usage as an embeddable script

Anywhere in your website you want to see the comment box, include

<script src="https://nocomment.netlify.app/embed.js" id="nocomment"></script>

You can pass special attributes to that <script> tag, such as

  • data-relays='["wss://my.custom.relay", "..."]', a JSON list of relay URLs to use instead of the default ones;
  • data-skip="/", a path of your website to skip rendering the widgets in. The default is "/".
  • data-owner='hex public key', a string with the post owner's public key in hex format.

Custom CSS variables for styling:

--nc-background: #003049;
--nc-text-background: #dddddd;
--nc-text-color: #eae2b7;
--nc-text-color-dark: #fcbf49;
--nc-primary-color: #fcbf49;
--nc-primary-contrast: #003049;

Usage as a React component

  1. yarn add react-nocomment
  2. Don't create an account anywhere.
  3. Don't configure a database.
  4. It just works. The URL is the identifier.
import { NoComment } from 'nocomment'

function App() {
  return (
    ...
      <NoComment relays={[
        'wss://nostr.drss.io',
        'wss://nostr-relay.freeberty.net',
        'wss://nostr.unknown.place',
        'wss://nostr-relay.untethr.me',
        'wss://relay.damus.io'
      ]} />
    ...
  );
}

License

Public domain.

nocomment's People

Contributors

fiatjaf avatar saiy2k avatar giszmo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.