npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

social-image-kodyfire

v0.1.23

Published

Generate dynamic images for social media sharing based on HTML templates using Kodyfire CLI

Downloads

24

Readme

Welcome to social-image-kodyfire 👋

Version Documentation License: MIT Twitter: anis_marrouchi

Generate a dynamic image for social media sharing based on HTML templates using Kodyfire. This is just the beginning.

🏠 Homepage

Requirements

social-image-kodyfire requires the kodyfire-cli to be installed

npm install -g kodyfire-cli

Install

npm install social-image-kodyfire

Usage

Method 1: As a generator

In order to generate your artifacts, run the generate command. The syntax is kody generate|g [kody] [concept]. If you ommit kody and concept the assistant will prompt you to select them. As an example, run the following command from your terminal:

kody generate react component

Method 2: As a kody project

Refer to the kodyfire generate your artifact section. Once your project is initialized and ready for kody, run the following command to generate your images.

kody run -s kody-social-image.json

Available Templates

basic (credits: puppeteer-social-image)

Renders text on a background image.

Params
  • title string - text to render
  • logo string - URL for the logo
  • imageUrl string - URL for the background image
  • background string - Valid CSS background color
  • color string - Valid CSS color
  • watermark string - (optional) text for footer

article (credits: puppeteer-social-image)

Display a title and subtitle on a background image, with an optional eyebrow

Params
  • title string - title text
  • subtitle string - subtitle text
  • eyebrow string - eyebrow text that renders above the title. Use for date
  • logo string - URL for the logo
  • imageUrl string - URL for the background image
  • background string - Valid CSS background color
  • color string - Valid CSS color
  • watermark string - (optional) text for footer

fiftyfifty (credits: puppeteer-social-image)

Tempate with split content

Params
  • title string - title text
  • subtitle string - subtitle text
  • logo string - URL for the logo
  • imageUrl string - URL for the background image
  • background string - Valid CSS background color
  • color string - Valid CSS color
  • watermark string - (optional) text for footer

doodle (credits: css-doodle)

Tempate using the doodle-css as background

Params
  • title string - title text
  • subtitle string - subtitle text
  • logo string - URL for the logo
  • doodle enum - doodle background name [fakeBox, neon, seeding, strings, timeTravel,tubes, unicode]
  • color string - Valid CSS color
  • watermark string - (optional) text for footer

Add the following params to your generated concepts. As an example, the final updated concepts might look like the following:

{
      "name": "image-3",
      "template": "fiftyfifty.html.template",
      "split": "diagonal",
      "fontWeight": "medium",
      "fontSize": "80px",
      "title": "Hello World!",
      "subtitle": "Your subtitle",
      "eyebrow": "17 July 2022",
      "logo": "https://noqta.tn/_next/image?url=%2Fimages%2Flogo.svg&w=256&q=75",
      "background": "tranparent",
      "imageUrl": "https://images.unsplash.com/photo-1507608869274-d3177c8bb4c7?w=1950&q=80",
      "color": "#000",
      "includeWatermark": true,
      "watermark": "social-image-kodyfire",
      "size": "facebook",
      "outputDir": ""
    }

📅 Future Features

  • Add common social post dimensions as size
  • Allow passing arguments to doodles
  • Compose doodle for dymamic backgrounds
  • Add template for most common post subjects
  • Add add meme template

Run tests

TODO

Author

👤 Anis Marrouchi

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

Credits

📝 License

Copyright © 2022 Anis Marrouchi.

This project is MIT licensed.


This README was generated with ❤️ by readme-kodyfire