Giter Club home page Giter Club logo

github-to-webmention's Introduction

Github to Webmention

Send webmentions for new and updated posts on a static site.

This is still in a proof of concept stage, but it is working. I will clean it up and flush out documentation soon.

Variable Description
PORT Port number
BRANCH_NAME Git branch name to watch (defaults to master)
CONTENT_DIRECTORY The directory in your repository to monitor for changes
WEBSITE_URL URL where your site is hosted
RETRY_DELAY_SECONDS If your page is not found, number of seconds to wait before retrying (defaults to 45)
MAX_RETRIES If your page is not found, max number of times to retry (defaults to 5)

This app assumes you have some sort of automatic build of your site from GitHub, whether GitHub pages, Netlify, or some other service. Because builds can take a little time to finish and publish, your newly posted pages may not be available as soon as GitHub notifies github-to-webmention of the change. If your page is not found, github-to-webmention will wait and retry several times until it is found (or MAX_RETRIES is exceeded).

github-to-webmention's People

Contributors

keithjgrant avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

dotcs

github-to-webmention's Issues

Add INITIAL_DELAY option

Instead of trying to fetch the page immediately, wait a specified number of seconds to allow the site to build and deploy (i.e. on Netlify).

Documentation

Document:

  • Problem this solves
  • Basic use
  • Config variables

Proper logging

Replace console.log() calls with a proper logger. Use debug logging to reduce verbosity of logs when not in a debug mode.

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.