-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
61 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,47 @@ | ||
|
||
# Default Template | ||
|
||
This is a template that leverages the experimental templates feature in the `pkg.pr.new` tool. | ||
|
||
## Overview | ||
|
||
Templates are particularly useful for creating live, interactive examples of your packages, which can be very beneficial for both development and documentation purposes. | ||
|
||
As a user, you can check the package.json file and see the new generated packages! You can just copy those and put them in your package.json or install them with your favorite package manager. | ||
|
||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/mdsvex@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/pfm-parse@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svast@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svast-stringify@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svast-utils@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svelte-parse@e9631f1 | ||
``` | ||
|
||
|
||
## Usage | ||
|
||
To use this feature as a maintainer, you can run the following command: | ||
|
||
```sh | ||
npx pkg-pr-new publish './packages/A' --template './examples/*' | ||
``` | ||
|
||
## Benefits | ||
|
||
- Interactive Demos: Automatically create live demos that users can interact with directly in their browser. | ||
- Enhanced Testing: Quickly spin up environments to test your package in different scenarios. | ||
- Improved Sharing: Easily share working examples of your package with collaborators or users without needing them to set up their environment. | ||
# Default Template | ||
|
||
This is a template that leverages the experimental templates feature in the `pkg.pr.new` tool. | ||
|
||
## Overview | ||
|
||
Templates are particularly useful for creating live, interactive examples of your packages, which can be very beneficial for both development and documentation purposes. | ||
|
||
As a user, you can check the package.json file and see the new generated packages! You can just copy those and put them in your package.json or install them with your favorite package manager. | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/mdsvex@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/pfm-parse@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svast@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svast-stringify@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svast-utils@e9631f1 | ||
``` | ||
|
||
```sh | ||
npm i https://pkg.pr.new/pngwn/MDsveX/svelte-parse@e9631f1 | ||
``` | ||
|
||
## Usage | ||
|
||
To use this feature as a maintainer, you can run the following command: | ||
|
||
```sh | ||
npx pkg-pr-new publish './packages/A' --template './examples/*' | ||
``` | ||
|
||
## Benefits | ||
|
||
- Interactive Demos: Automatically create live demos that users can interact with directly in their browser. | ||
- Enhanced Testing: Quickly spin up environments to test your package in different scenarios. | ||
- Improved Sharing: Easily share working examples of your package with collaborators or users without needing them to set up their environment. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,14 @@ | ||
{ | ||
"name": "mdsvex-test", | ||
"version": "1.0.0", | ||
"description": "generated by pkg.pr.new", | ||
"main": "index.js", | ||
"dependencies": { | ||
"mdsvex": "workspace:*" | ||
}, | ||
"keywords": [], | ||
"author": "pkg.pr.new", | ||
"license": "ISC", | ||
"private": "true", | ||
"type": "module" | ||
} | ||
{ | ||
"name": "mdsvex-test", | ||
"version": "1.0.0", | ||
"description": "generated by pkg.pr.new", | ||
"main": "index.js", | ||
"dependencies": { | ||
"mdsvex": "workspace:*" | ||
}, | ||
"keywords": [], | ||
"author": "pkg.pr.new", | ||
"license": "ISC", | ||
"private": "true", | ||
"type": "module" | ||
} |