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

artalk-plugin-sample

v1.0.0

Published

This is a template for creating a new plugin for Artalk.

Downloads

5

Readme

Artalk Plugin Sample

This is a template for creating a new plugin for Artalk.

Getting Started

To get started with creating your Artalk plugin, follow these steps:

  1. Clone this repository: Begin by cloning this repository to your local machine.

    git clone <repository_url>
  2. Install dependencies: Navigate to the cloned directory and install the required dependencies.

    cd <cloned_directory>
    pnpm install
  3. Modify the plugin: You can now start modifying the plugin code to suit your needs. The main files to focus on are src/main.ts and any other relevant files within the plugin directory.

    Execute the following command to start the development server.

    pnpm dev

    This will start a development server that watches for changes to your plugin files and automatically reloads the plugin in the browser.

  4. Test your plugin: It's essential to test your plugin thoroughly to ensure it functions as expected. You can use the provided testing framework or integrate it with your Artalk instance for real-world testing.

  5. Document your plugin: Update the README.md file to provide clear documentation for your plugin. Include information such as installation instructions, configuration options, usage examples, and any other relevant details.

  6. Build your plugin: Before publishing your plugin, you may want to build it for production. Use the following command to build your plugin:

    pnpm build
  7. Publish your plugin (optional): If you're satisfied with your plugin and want to share it with others, consider publishing it to a package registry or the Artalk community. Follow the respective guidelines for publishing plugins.

    pnpm publish
  8. Contribute: If you think your plugin could benefit the broader community, consider contributing it to the official Artalk repository or sharing it on relevant platforms.

Resources

Here are some additional resources that may be helpful during the plugin development process:

Support

If you encounter any issues or have questions about plugin development, feel free to reach out to the Artalk community for support. You can also open an issue on the GitHub repository for assistance.

Happy coding! 🚀