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

@hideoo/generator-starlight-plugin

v0.2.0

Published

Yeoman generator for Starlight plugins.

Downloads

56

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

hideoohideoo

Keywords

yeoman-generatorstarlightplugindocumentationastro

Readme

Features

An opinionated but still lightweight Yeoman generator to help create Starlight plugins.

  • opinionated: Git and pnpm are required to generate a monorepo containing a Starlight plugin package and a Starlight documentation project acting at the same time as a playground to test your plugin. The plugin is expected to be written in TypeScript, hosted on GitHub, and licensed under the MIT license.
  • lightweight: Formatting, linting, testing, bundling, publishing, deploying the documentation, which are all optional for a Starlight plugin, are not enforced by the generator. You are free to add them to your project as you see fit using the tools and services you prefer.

Usage

To use the generator, run the following command in your terminal from the directory where you want to work on your plugin:

npx -p yo -p @hideoo/generator-starlight-plugin -- yo @hideoo/starlight-plugin

To start creating your Starlight plugin, edit the packages/plugin-name/index.ts file which will be the entry point of your plugin.

To test your plugin, run the following command from the docs/ directory:

pnpm dev

To learn more about plugin development, check the Starlight documentation.

Project Structure

The generated project uses a monorepo structure with different pnpm workspaces:

  • docs/: A Starlight documentation project to document your plugin that also acts as a playground to test it.
  • packages/plugin-name/: A package containing your Starlight plugin.

Resources

The generated project contains the bare minimum to get started with a Starlight plugin. Here are some additional resources to help you develop and release your plugin:

[!TIP] After deploying your documentation, add a link to it in the packages/plugin-name/README.md file to help users find it.

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.