vuejs / vuejs/docs

Cookbook Idea: Publishing to NPM

Open
#965 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content cookbook
Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

There is a V2 cookbook recipe for publishing to NPM, but not one for V3 yet. I would greatly appreciate an official guide for this, because there are a wide number of articles out there as to how to do this, and they often contradict or seem like they do not utilize the best coding practices.

Thanks so much for all the work you guys do!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Vue 2 cookbook recipe for packaging a single-file component library for NPM, then identify the current Vue 3 packaging guidance and examples in this documentation repository. Done means an official Vue 3 guide covers the recommended publishing workflow clearly and consistently, with any relevant documentation checks passing.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.