From c60dff973a67ee967e79c936ce8a442a1419c41e Mon Sep 17 00:00:00 2001 From: aayushRedHat Date: Thu, 18 Jan 2024 15:29:34 +0530 Subject: [PATCH] update doc --- docs/using-private-template.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/using-private-template.md b/docs/using-private-template.md index 26b37de04..6b8556c4f 100644 --- a/docs/using-private-template.md +++ b/docs/using-private-template.md @@ -2,16 +2,16 @@ title: "Using private templates" weight: 180 --- -Generator allows to fetch the template from the private repositories like verdaccio, nexus, npm etc. +Generator allows fetching the template from private repositories like Verdaccio, Nexus, npm, etc. -## Private registry options +## Private registry options: -* **registry.url**: The URL of the registry where is private template is present. Defaults to `registry.npmjs.org`. -* **registry.auth**: Optional parameter to pass npm registry username and password encoded with base64, formatted like `username:password`. For example if the username and password is `admin` and `nimda`, you need to encode with base64 value like `admin:nimda` which results in `YWRtaW46bmltZGE=`. -* **registry.token** : Optional parameter to pass to npm registry auth token. To get the token you can first authenticate with registry using `npm login` and then grab generated token from `.npmrc` file. +* **registry.url**: The URL of the registry where the private template is located. Defaults to `registry.npmjs.org`. +* **registry.auth**: An optional parameter to pass the npm registry username and password encoded with base64, formatted as `username:password`. For example, if the username and password are `admin` and `nimda`, you need to encode them with the base64 value like `admin:nimda` which results in `YWRtaW46bmltZGE=`. +**registry.token**: An optional parameter to pass to the npm registry authentication token. To get the token, you can first authenticate with the registry using `npm login` and then grab the generated token from the `.npmrc` file. -## Pulling private template using library +## Pulling private template using library: ```javascript const generator = new Generator('@asyncapi/html-template', 'output', @@ -26,4 +26,4 @@ const generator = new Generator('@asyncapi/html-template', 'output', } }); ``` -Let's assume you host `@asyncapi/html-template` in private package registry like Verdaccio. In order to pull this template you need to provide `registry.url` option that points to the registry URL and `registry.auth` as base64 encoded value that represents username and password. Instead of username and password you can also pass `registry.token`. \ No newline at end of file +Assuming you host `@asyncapi/html-template` in a private package registry like Verdaccio. To pull this template, you need to provide `registry.url` option that points to the registry URL and `registry.auth` as a base64 encoded value that represents the username and password. Instead of username and password, you can also pass `registry.token`. \ No newline at end of file