From 185dedebbde235919ddb401e8a57fa5c8c6cdad0 Mon Sep 17 00:00:00 2001 From: pngwn Date: Wed, 21 Aug 2024 13:10:34 +0100 Subject: [PATCH] format --- packages/template/README.md | 97 ++++++++++++++++------------------ packages/template/package.json | 28 +++++----- 2 files changed, 61 insertions(+), 64 deletions(-) diff --git a/packages/template/README.md b/packages/template/README.md index 285765bb..3a6fba6e 100644 --- a/packages/template/README.md +++ b/packages/template/README.md @@ -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. diff --git a/packages/template/package.json b/packages/template/package.json index d697fb35..16061ce5 100644 --- a/packages/template/package.json +++ b/packages/template/package.json @@ -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" +}