@teambit/pkg.aspect-docs.pkg 0.0.0-96af1a186d7e33351b25fd4a290b75653da81de6

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default as Pkg } from './pkg.mdx';

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pkg = void 0;
+var pkg_mdx_1 = require("./pkg.mdx");
+Object.defineProperty(exports, "Pkg", { enumerable: true, get: function () { return __importDefault(pkg_mdx_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAA2C;AAAlC,+GAAA,OAAO,OAAO"}

package/dist/pkg.composition.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const PkgDocs: () => React.JSX.Element;

package/dist/pkg.composition.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PkgDocs = void 0;
+const react_1 = __importDefault(require("react"));
+const documenter_theme_theme_compositions_1 = require("@teambit/documenter.theme.theme-compositions");
+const mdx_ui_mdx_layout_1 = require("@teambit/mdx.ui.mdx-layout");
+const index_1 = require("./index");
+const PkgDocs = () => (react_1.default.createElement(documenter_theme_theme_compositions_1.ThemeCompositions, null,
+    react_1.default.createElement(mdx_ui_mdx_layout_1.MDXLayout, null,
+        react_1.default.createElement(index_1.Pkg, null))));
+exports.PkgDocs = PkgDocs;
+//# sourceMappingURL=pkg.composition.js.map

package/dist/pkg.composition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pkg.composition.js","sourceRoot":"","sources":["../pkg.composition.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,sGAAiF;AACjF,kEAAuD;AACvD,mCAA8B;AAEvB,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,CAC3B,8BAAC,uDAAiB;IAChB,8BAAC,6BAAS;QACR,8BAAC,WAAG,OAAG,CACG,CACM,CACrB,CAAC;AANW,QAAA,OAAO,WAMlB"}

package/dist/pkg.docs.mdx

@@ -0,0 +1,34 @@
+---
+description: 'Docs for Pkg aspect'
+labels: ['docs', 'aspect', 'extensions']
+---
+
+import { Pkg } from './index';
+
+## Static Content Page in Pkg
+
+Docs for Pkg aspect
+
+### Component usage
+
+Use your component in any Pkg file:
+
+```js
+import { Pkg } from '@teambit/aspect-docs.pkg';
+
+<Pkg />;
+```
+
+### Render with theme and Pkg providers
+
+```js
+import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
+import { PkgLayout } from '@teambit/ui.Pkg-layout';
+import { Pkg } from '@teambit/aspect-docs.pkg';
+
+<ThemeCompositions>
+  <PkgLayout>
+    <Pkg />
+  </PkgLayout>
+</ThemeCompositions>;
+```

package/dist/pkg.mdx.js

@@ -0,0 +1,164 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = MDXContent;
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@mdx-js/react");
+var _excluded = ["components"]; // @ts-nocheck
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+/* @jsxRuntime classic */
+/* @jsx mdx */
+
+var layoutProps = {};
+var MDXLayout = "wrapper";
+function MDXContent(_ref) {
+  var components = _ref.components,
+    props = _objectWithoutProperties(_ref, _excluded);
+  return (0, _react2.mdx)(MDXLayout, _extends({}, layoutProps, props, {
+    components: components,
+    mdxType: "MDXLayout"
+  }), (0, _react2.mdx)("p", null, "Bit components can be thought of as a super-set of standard packaged node modules.\nEach component contains a consumable package in addition to its documentation, history and other information that enables it to be independently developed and maintained."), (0, _react2.mdx)("p", null, "The PKG aspect handles the configuration, publishing and packing of component packages.\nIt adds its own build task to the build pipeline, to create component packages and include them in as part of the component artifacts.\nThis automation includes generating the package name and other properties according to the component's details."), (0, _react2.mdx)("h4", null, "Features"), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "li"
+  }, "Efficient ", (0, _react2.mdx)("inlineCode", {
+    parentName: "strong"
+  }, "package.json"), " configuration:"), " Use the PKG's workspace config API to add or override ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "package.json"), " properties to a group of components, all at once.\nUse PKG's 'placeholders' to integrate component-specific data into the component's package configurations."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "li"
+  }, "An API for programmable ", (0, _react2.mdx)("inlineCode", {
+    parentName: "strong"
+  }, "package.json"), " configuration:"), " Use PKG's API to provide your extensions with \"packaging capabilities\". Modify the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "package.json"), " to suit your extension's needs, whether it is an environment or any other type of extension."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "li"
+  }, "Automated packing and publishing:"), " - PKG is registered to your build pipeline. That means every 'build' will also test 'packing' and every tagging of a new release version will also include 'publishing'. Your components and packages versions are alway in-sync."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("strong", {
+    parentName: "li"
+  }, "\"On-demand\" packing and publishing:"), " - PKG offers the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "pack"), " and ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "preview"), " CLI commands for a manual and on-demand usage.")), (0, _react2.mdx)("h3", null, "Quickstart & configuration"), (0, _react2.mdx)("blockquote", null, (0, _react2.mdx)("p", {
+    parentName: "blockquote"
+  }, "This aspect is only configurable using the 'variants' workspace API.")), (0, _react2.mdx)("h4", null, "Package properties"), (0, _react2.mdx)("p", null, "Use the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "packageJson"), " property to add or override the default ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "package.json"), " for your component packages."), (0, _react2.mdx)("blockquote", null, (0, _react2.mdx)("p", {
+    parentName: "blockquote"
+  }, "Warning! Packages with a modified ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "name"), " property will not be published to Bit.dev's registry.")), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-js"
+  }, "{\n  \"ui/*\": {\n    \"teambit.pkg/pkg\": {\n      \"packageJson\": {\n          \"name\": \"@{scope}/{name}\",\n          \"private\": false,\n          \"main\": \"dist/{main}.js\",\n          \"custom-prop\": \"value\"\n      }\n    }\n  }\n}\n")), (0, _react2.mdx)("h4", null, "Publish"), (0, _react2.mdx)("blockquote", null, (0, _react2.mdx)("p", {
+    parentName: "blockquote"
+  }, "If ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "publishConfig"), " or ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "name"), " are not set, packages will be published to Bit.dev's registry.")), (0, _react2.mdx)("h5", null, "npm arguments"), (0, _react2.mdx)("p", null, "You can specify additional arguments to the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "npm publish"), " command by adding an array of args to ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "packageManagerPublishArgs"), "."), (0, _react2.mdx)("p", null, "For example:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-js"
+  }, "\"ui/*\": {\n  \"teambit.pkg/pkg\": {\n    \"packageManagerPublishArgs\": [\"--access public\"]\n  }\n}\n")), (0, _react2.mdx)("h4", null, "npmjs Registry"), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, "Use the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "name"), " property to set the publishing process to your ", (0, _react2.mdx)("a", {
+    parentName: "li",
+    "href": "https://docs.npmjs.com/cli/v6/using-npm/scope"
+  }, "npm scope"), "."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, "Use the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "private"), " ", (0, _react2.mdx)("em", {
+    parentName: "li"
+  }, "(boolean)"), " property to set packages to be published with either private or public access.")), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-js"
+  }, "{\n  \"ui/*\": {\n    \"teambit.pkg/pkg\": {\n      \"packageJson\": {\n          \"name\": \"@{scope}/{name}\",\n          \"private\": false,\n      }\n    }\n  }\n}\n")), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, "By default, when specifying ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "name"), " or ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "publishConfig"), ", it'll publish to NPM. In some rare cases, this is not desired, to cancel it, add the config ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "\"avoidPublishToNPM\": true"))), (0, _react2.mdx)("h4", null, "Private registry"), (0, _react2.mdx)("p", null, "Use the ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "scope"), " and ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "registry"), " properties to configure the publishing process to your own private registry (and scope)."), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-js"
+  }, "\"ui/*\": {\n  \"teambit.pkg/pkg\": {\n    \"packageJson\": {\n       \"publishConfig\": {\n         \"scope\": \"@custom\",\n         \"registry\": \"http://localhost:4873\"\n      }\n    }\n  }\n}\n")), (0, _react2.mdx)("blockquote", null, (0, _react2.mdx)("p", {
+    parentName: "blockquote"
+  }, "Packages with a modified ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "publishConfig"), " property will not be published to Bit.dev's registry.")), (0, _react2.mdx)("h4", null, "Placeholders"), (0, _react2.mdx)("p", null, "Placeholders are an easy way to inject component-specific information into the 'pkg' configurations."), (0, _react2.mdx)("ul", null, (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "{name}"), " - The name of the component."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "{scope}"), " - The name of the component scope."), (0, _react2.mdx)("li", {
+    parentName: "ul"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "{main}"), " - the name of the main file (leaving out the extension) - for example ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "index.js"), " will be ", (0, _react2.mdx)("inlineCode", {
+    parentName: "li"
+  }, "index"), ".")), (0, _react2.mdx)("p", null, "For example:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-js"
+  }, " \"packageJson\": {\n    \"main\": \"dist/{main}.js\"\n  }\n")), (0, _react2.mdx)("h4", null, ".npmignore"), (0, _react2.mdx)("p", null, "Add records to the .npmignore file before a package is published or pack.\nFor example, if you don't want the source files to be part of the package, you can add them to the .npmignore."), (0, _react2.mdx)("p", null, "The API to add records to this file is exposed in the environment: ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "getNpmIgnore()"), "."), (0, _react2.mdx)("p", null, "For example, the following was added to the Aspect env."), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-js"
+  }, "getNpmIgnore() {\n  // ignores only .ts files in the root directory, so d.ts files inside dists are unaffected.\n  return ['/*.ts']\n}\n")), (0, _react2.mdx)("h3", null, "CLI Reference"), (0, _react2.mdx)("h4", null, "Pack"), (0, _react2.mdx)("p", null, "Creates a TAR file (to be published to a node package registry):"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-shell"
+  }, "bit pack <component-id>\n")), (0, _react2.mdx)("p", null, "Overrides the existing TAR file (in the same location):"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-shell"
+  }, "bit pack <component-id> --override\n\nbit pack <component-id> -o\n")), (0, _react2.mdx)("p", null, "Returns the output in a JSON format:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-shell"
+  }, "bit pack <component-id> --json\n\nbit pack <component-id> -j\n")), (0, _react2.mdx)("h4", null, "Publish"), (0, _react2.mdx)("p", null, "Publishes an exported component:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-shell"
+  }, "bit publish <componentId>\n")), (0, _react2.mdx)("p", null, "Publishes a staged component that has not yet been exported:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-shell"
+  }, "bit publish <component-id> --allow-staged\n")), (0, _react2.mdx)("p", null, "Checks if the publishing process will be done successfully (without publishing):"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-shell"
+  }, "bit publish <component-id> --dry-run\n\nbit publish <component-id> -d\n")), (0, _react2.mdx)("p", null, "Returns the output as JSON:"), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
+    parentName: "pre",
+    "className": "language-shell"
+  }, "bit publish <component-id> --json\n\nbit publish <component-id> --j\n")));
+}
+;
+MDXContent.isMDXComponent = true;
+
+//# sourceMappingURL=pkg.mdx.js.map

package/dist/pkg.mdx.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_react","_interopRequireDefault","require","_react2","_excluded","e","__esModule","_extends","Object","assign","bind","n","arguments","length","t","r","hasOwnProperty","call","apply","_objectWithoutProperties","o","i","_objectWithoutPropertiesLoose","getOwnPropertySymbols","indexOf","propertyIsEnumerable","layoutProps","MDXLayout","MDXContent","_ref","components","props","mdx","mdxType","parentName","isMDXComponent"],"sourceRoot":"/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.pkg_aspect-docs_pkg@96af1a186d7e33351b25fd4a290b75653da81de6","sources":["pkg.mdx.js"],"sourcesContent":["\n// @ts-nocheck\nimport React from 'react'\nimport { mdx } from '@mdx-js/react'\n\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\n\n\n\nconst layoutProps = {\n  \n};\nconst MDXLayout = \"wrapper\"\nexport default function MDXContent({\n  components,\n  ...props\n}) {\n  return <MDXLayout {...layoutProps} {...props} components={components} mdxType=\"MDXLayout\">\n    <p>{`Bit components can be thought of as a super-set of standard packaged node modules.\nEach component contains a consumable package in addition to its documentation, history and other information that enables it to be independently developed and maintained.`}</p>\n    <p>{`The PKG aspect handles the configuration, publishing and packing of component packages.\nIt adds its own build task to the build pipeline, to create component packages and include them in as part of the component artifacts.\nThis automation includes generating the package name and other properties according to the component's details.`}</p>\n    <h4>{`Features`}</h4>\n    <ul>\n      <li parentName=\"ul\"><strong parentName=\"li\">{`Efficient `}<inlineCode parentName=\"strong\">{`package.json`}</inlineCode>{` configuration:`}</strong>{` Use the PKG's workspace config API to add or override `}<inlineCode parentName=\"li\">{`package.json`}</inlineCode>{` properties to a group of components, all at once.\nUse PKG's 'placeholders' to integrate component-specific data into the component's package configurations.`}</li>\n      <li parentName=\"ul\"><strong parentName=\"li\">{`An API for programmable `}<inlineCode parentName=\"strong\">{`package.json`}</inlineCode>{` configuration:`}</strong>{` Use PKG's API to provide your extensions with \"packaging capabilities\". Modify the `}<inlineCode parentName=\"li\">{`package.json`}</inlineCode>{` to suit your extension's needs, whether it is an environment or any other type of extension.`}</li>\n      <li parentName=\"ul\"><strong parentName=\"li\">{`Automated packing and publishing:`}</strong>{` - PKG is registered to your build pipeline. That means every 'build' will also test 'packing' and every tagging of a new release version will also include 'publishing'. Your components and packages versions are alway in-sync.`}</li>\n      <li parentName=\"ul\"><strong parentName=\"li\">{`\"On-demand\" packing and publishing:`}</strong>{` - PKG offers the `}<inlineCode parentName=\"li\">{`pack`}</inlineCode>{` and `}<inlineCode parentName=\"li\">{`preview`}</inlineCode>{` CLI commands for a manual and on-demand usage.`}</li>\n    </ul>\n    <h3>{`Quickstart & configuration`}</h3>\n    <blockquote>\n      <p parentName=\"blockquote\">{`This aspect is only configurable using the 'variants' workspace API.`}</p>\n    </blockquote>\n    <h4>{`Package properties`}</h4>\n    <p>{`Use the `}<inlineCode parentName=\"p\">{`packageJson`}</inlineCode>{` property to add or override the default `}<inlineCode parentName=\"p\">{`package.json`}</inlineCode>{` for your component packages.`}</p>\n    <blockquote>\n      <p parentName=\"blockquote\">{`Warning! Packages with a modified `}<inlineCode parentName=\"p\">{`name`}</inlineCode>{` property will not be published to Bit.dev's registry.`}</p>\n    </blockquote>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-js\"\n      }}>{`{\n  \"ui/*\": {\n    \"teambit.pkg/pkg\": {\n      \"packageJson\": {\n          \"name\": \"@{scope}/{name}\",\n          \"private\": false,\n          \"main\": \"dist/{main}.js\",\n          \"custom-prop\": \"value\"\n      }\n    }\n  }\n}\n`}</code></pre>\n    <h4>{`Publish`}</h4>\n    <blockquote>\n      <p parentName=\"blockquote\">{`If `}<inlineCode parentName=\"p\">{`publishConfig`}</inlineCode>{` or `}<inlineCode parentName=\"p\">{`name`}</inlineCode>{` are not set, packages will be published to Bit.dev's registry.`}</p>\n    </blockquote>\n    <h5>{`npm arguments`}</h5>\n    <p>{`You can specify additional arguments to the `}<inlineCode parentName=\"p\">{`npm publish`}</inlineCode>{` command by adding an array of args to `}<inlineCode parentName=\"p\">{`packageManagerPublishArgs`}</inlineCode>{`.`}</p>\n    <p>{`For example:`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-js\"\n      }}>{`\"ui/*\": {\n  \"teambit.pkg/pkg\": {\n    \"packageManagerPublishArgs\": [\"--access public\"]\n  }\n}\n`}</code></pre>\n    <h4>{`npmjs Registry`}</h4>\n    <ul>\n      <li parentName=\"ul\">{`Use the `}<inlineCode parentName=\"li\">{`name`}</inlineCode>{` property to set the publishing process to your `}<a parentName=\"li\" {...{\n          \"href\": \"https://docs.npmjs.com/cli/v6/using-npm/scope\"\n        }}>{`npm scope`}</a>{`.`}</li>\n      <li parentName=\"ul\">{`Use the `}<inlineCode parentName=\"li\">{`private`}</inlineCode>{` `}<em parentName=\"li\">{`(boolean)`}</em>{` property to set packages to be published with either private or public access.`}</li>\n    </ul>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-js\"\n      }}>{`{\n  \"ui/*\": {\n    \"teambit.pkg/pkg\": {\n      \"packageJson\": {\n          \"name\": \"@{scope}/{name}\",\n          \"private\": false,\n      }\n    }\n  }\n}\n`}</code></pre>\n    <ul>\n      <li parentName=\"ul\">{`By default, when specifying `}<inlineCode parentName=\"li\">{`name`}</inlineCode>{` or `}<inlineCode parentName=\"li\">{`publishConfig`}</inlineCode>{`, it'll publish to NPM. In some rare cases, this is not desired, to cancel it, add the config `}<inlineCode parentName=\"li\">{`\"avoidPublishToNPM\": true`}</inlineCode></li>\n    </ul>\n    <h4>{`Private registry`}</h4>\n    <p>{`Use the `}<inlineCode parentName=\"p\">{`scope`}</inlineCode>{` and `}<inlineCode parentName=\"p\">{`registry`}</inlineCode>{` properties to configure the publishing process to your own private registry (and scope).`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-js\"\n      }}>{`\"ui/*\": {\n  \"teambit.pkg/pkg\": {\n    \"packageJson\": {\n       \"publishConfig\": {\n         \"scope\": \"@custom\",\n         \"registry\": \"http://localhost:4873\"\n      }\n    }\n  }\n}\n`}</code></pre>\n    <blockquote>\n      <p parentName=\"blockquote\">{`Packages with a modified `}<inlineCode parentName=\"p\">{`publishConfig`}</inlineCode>{` property will not be published to Bit.dev's registry.`}</p>\n    </blockquote>\n    <h4>{`Placeholders`}</h4>\n    <p>{`Placeholders are an easy way to inject component-specific information into the 'pkg' configurations.`}</p>\n    <ul>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`{name}`}</inlineCode>{` - The name of the component.`}</li>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`{scope}`}</inlineCode>{` - The name of the component scope.`}</li>\n      <li parentName=\"ul\"><inlineCode parentName=\"li\">{`{main}`}</inlineCode>{` - the name of the main file (leaving out the extension) - for example `}<inlineCode parentName=\"li\">{`index.js`}</inlineCode>{` will be `}<inlineCode parentName=\"li\">{`index`}</inlineCode>{`.`}</li>\n    </ul>\n    <p>{`For example:`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-js\"\n      }}>{` \"packageJson\": {\n    \"main\": \"dist/{main}.js\"\n  }\n`}</code></pre>\n    <h4>{`.npmignore`}</h4>\n    <p>{`Add records to the .npmignore file before a package is published or pack.\nFor example, if you don't want the source files to be part of the package, you can add them to the .npmignore.`}</p>\n    <p>{`The API to add records to this file is exposed in the environment: `}<inlineCode parentName=\"p\">{`getNpmIgnore()`}</inlineCode>{`.`}</p>\n    <p>{`For example, the following was added to the Aspect env.`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-js\"\n      }}>{`getNpmIgnore() {\n  // ignores only .ts files in the root directory, so d.ts files inside dists are unaffected.\n  return ['/*.ts']\n}\n`}</code></pre>\n    <h3>{`CLI Reference`}</h3>\n    <h4>{`Pack`}</h4>\n    <p>{`Creates a TAR file (to be published to a node package registry):`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-shell\"\n      }}>{`bit pack <component-id>\n`}</code></pre>\n    <p>{`Overrides the existing TAR file (in the same location):`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-shell\"\n      }}>{`bit pack <component-id> --override\n\nbit pack <component-id> -o\n`}</code></pre>\n    <p>{`Returns the output in a JSON format:`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-shell\"\n      }}>{`bit pack <component-id> --json\n\nbit pack <component-id> -j\n`}</code></pre>\n    <h4>{`Publish`}</h4>\n    <p>{`Publishes an exported component:`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-shell\"\n      }}>{`bit publish <componentId>\n`}</code></pre>\n    <p>{`Publishes a staged component that has not yet been exported:`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-shell\"\n      }}>{`bit publish <component-id> --allow-staged\n`}</code></pre>\n    <p>{`Checks if the publishing process will be done successfully (without publishing):`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-shell\"\n      }}>{`bit publish <component-id> --dry-run\n\nbit publish <component-id> -d\n`}</code></pre>\n    <p>{`Returns the output as JSON:`}</p>\n    <pre><code parentName=\"pre\" {...{\n        \"className\": \"language-shell\"\n      }}>{`bit publish <component-id> --json\n\nbit publish <component-id> --j\n`}</code></pre>\n    </MDXLayout>;\n}\n;\nMDXContent.isMDXComponent = true;"],"mappings":";;;;;;AAEA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AAAmC,IAAAE,SAAA,mBAFnC;AAAA,SAAAH,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,gBAAAA,CAAA;AAAA,SAAAE,SAAA,WAAAA,QAAA,GAAAC,MAAA,CAAAC,MAAA,GAAAD,MAAA,CAAAC,MAAA,CAAAC,IAAA,eAAAC,CAAA,aAAAN,CAAA,MAAAA,CAAA,GAAAO,SAAA,CAAAC,MAAA,EAAAR,CAAA,UAAAS,CAAA,GAAAF,SAAA,CAAAP,CAAA,YAAAU,CAAA,IAAAD,CAAA,OAAAE,cAAA,CAAAC,IAAA,CAAAH,CAAA,EAAAC,CAAA,MAAAJ,CAAA,CAAAI,CAAA,IAAAD,CAAA,CAAAC,CAAA,aAAAJ,CAAA,KAAAJ,QAAA,CAAAW,KAAA,OAAAN,SAAA;AAAA,SAAAO,yBAAAd,CAAA,EAAAS,CAAA,gBAAAT,CAAA,iBAAAe,CAAA,EAAAL,CAAA,EAAAM,CAAA,GAAAC,6BAAA,CAAAjB,CAAA,EAAAS,CAAA,OAAAN,MAAA,CAAAe,qBAAA,QAAAZ,CAAA,GAAAH,MAAA,CAAAe,qBAAA,CAAAlB,CAAA,QAAAU,CAAA,MAAAA,CAAA,GAAAJ,CAAA,CAAAE,MAAA,EAAAE,CAAA,IAAAK,CAAA,GAAAT,CAAA,CAAAI,CAAA,UAAAD,CAAA,CAAAU,OAAA,CAAAJ,CAAA,QAAAK,oBAAA,CAAAR,IAAA,CAAAZ,CAAA,EAAAe,CAAA,MAAAC,CAAA,CAAAD,CAAA,IAAAf,CAAA,CAAAe,CAAA,aAAAC,CAAA;AAAA,SAAAC,8BAAAP,CAAA,EAAAV,CAAA,gBAAAU,CAAA,iBAAAD,CAAA,gBAAAH,CAAA,IAAAI,CAAA,SAAAC,cAAA,CAAAC,IAAA,CAAAF,CAAA,EAAAJ,CAAA,gBAAAN,CAAA,CAAAmB,OAAA,CAAAb,CAAA,aAAAG,CAAA,CAAAH,CAAA,IAAAI,CAAA,CAAAJ,CAAA,YAAAG,CAAA;AAIA;AACA;;AAKA,IAAMY,WAAW,GAAG,CAEpB,CAAC;AACD,IAAMC,SAAS,GAAG,SAAS;AACZ,SAASC,UAAUA,CAAAC,IAAA,EAG/B;EAAA,IAFDC,UAAU,GAAAD,IAAA,CAAVC,UAAU;IACPC,KAAK,GAAAZ,wBAAA,CAAAU,IAAA,EAAAzB,SAAA;EAER,OAAO,IAAAD,OAAA,CAAA6B,GAAA,EAACL,SAAS,EAAApB,QAAA,KAAKmB,WAAW,EAAMK,KAAK;IAAED,UAAU,EAAEA,UAAW;IAACG,OAAO,EAAC;EAAW,IACvF,IAAA9B,OAAA,CAAA6B,GAAA,6QAC2K,CAAC,EAC5K,IAAA7B,OAAA,CAAA6B,GAAA,+VAEgH,CAAC,EACjH,IAAA7B,OAAA,CAAA6B,GAAA,wBAAoB,CAAC,EACrB,IAAA7B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAI,iBAAe,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAQ,iBAA6B,CAAC,mBAA2B,CAAC,6DAA2D,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,iBAA6B,CAAC,kKAC7J,CAAC,EAC3G,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAI,+BAA6B,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAQ,iBAA6B,CAAC,mBAA2B,CAAC,4FAAwF,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,iBAA6B,CAAC,iGAAqG,CAAC,EACxZ,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAI,sCAA8C,CAAC,sOAA0O,CAAC,EACrU,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAI,0CAAgD,CAAC,wBAAsB,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,SAAqB,CAAC,WAAS,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,YAAwB,CAAC,mDAAuD,CACrR,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,0CAAsC,CAAC,EACvC,IAAA7B,OAAA,CAAA6B,GAAA,sBACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAY,yEAA4E,CAC5F,CAAC,EACb,IAAA/B,OAAA,CAAA6B,GAAA,kCAA8B,CAAC,EAC/B,IAAA7B,OAAA,CAAA6B,GAAA,yBAAe,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,gBAA4B,CAAC,+CAA6C,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,iBAA6B,CAAC,iCAAoC,CAAC,EAChN,IAAA/B,OAAA,CAAA6B,GAAA,sBACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAY,yCAAuC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,SAAqB,CAAC,0DAA6D,CACpK,CAAC,EACb,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAa,6PAa1B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,uBAAmB,CAAC,EACpB,IAAA7B,OAAA,CAAA6B,GAAA,sBACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAY,UAAQ,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,kBAA8B,CAAC,UAAQ,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,SAAqB,CAAC,mEAAsE,CAC/M,CAAC,EACb,IAAA/B,OAAA,CAAA6B,GAAA,6BAAyB,CAAC,EAC1B,IAAA7B,OAAA,CAAA6B,GAAA,6DAAmD,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,gBAA4B,CAAC,6CAA2C,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,8BAA0C,CAAC,KAAQ,CAAC,EACnO,IAAA/B,OAAA,CAAA6B,GAAA,2BAAsB,CAAC,EACvB,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAa,8GAM1B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,8BAA0B,CAAC,EAC3B,IAAA7B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,eAAa,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,SAAqB,CAAC,sDAAoD,IAAA/B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC,IAAI;IACnJ,MAAM,EAAE;EAA+C,cACtC,CAAC,KAAS,CAAC,EAChC,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,eAAa,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,YAAwB,CAAC,OAAK,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,cAAkB,CAAC,mFAAuF,CACpN,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAa,8KAW1B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,mCAAiC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,SAAqB,CAAC,UAAQ,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,kBAA8B,CAAC,oGAAkG,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,gCAA0C,CAAK,CACjV,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,gCAA4B,CAAC,EAC7B,IAAA7B,OAAA,CAAA6B,GAAA,yBAAe,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,UAAsB,CAAC,WAAS,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,aAAyB,CAAC,6FAAgG,CAAC,EAC9N,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAa,6MAW1B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,sBACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAY,gCAA8B,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,kBAA8B,CAAC,0DAA6D,CACpK,CAAC,EACb,IAAA/B,OAAA,CAAA6B,GAAA,4BAAwB,CAAC,EACzB,IAAA7B,OAAA,CAAA6B,GAAA,mHAA8G,CAAC,EAC/G,IAAA7B,OAAA,CAAA6B,GAAA,cACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,WAAuB,CAAC,iCAAqC,CAAC,EAC7G,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,YAAwB,CAAC,uCAA2C,CAAC,EACpH,IAAA/B,OAAA,CAAA6B,GAAA;IAAIE,UAAU,EAAC;EAAI,GAAC,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,WAAuB,CAAC,6EAA2E,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,aAAyB,CAAC,eAAa,IAAA/B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAI,UAAsB,CAAC,KAAS,CAC7Q,CAAC,EACL,IAAA/B,OAAA,CAAA6B,GAAA,2BAAsB,CAAC,EACvB,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAa,iEAI1B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,0BAAsB,CAAC,EACvB,IAAA7B,OAAA,CAAA6B,GAAA,wMAC+G,CAAC,EAChH,IAAA7B,OAAA,CAAA6B,GAAA,oFAA0E,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,mBAA+B,CAAC,KAAQ,CAAC,EAC7I,IAAA/B,OAAA,CAAA6B,GAAA,sEAAiE,CAAC,EAClE,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAa,6IAK1B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,6BAAyB,CAAC,EAC1B,IAAA7B,OAAA,CAAA6B,GAAA,oBAAgB,CAAC,EACjB,IAAA7B,OAAA,CAAA6B,GAAA,+EAA0E,CAAC,EAC3E,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAgB,8BAE7B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,sEAAiE,CAAC,EAClE,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAgB,uEAI7B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,mDAA8C,CAAC,EAC/C,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAgB,mEAI7B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,uBAAmB,CAAC,EACpB,IAAA7B,OAAA,CAAA6B,GAAA,+CAA0C,CAAC,EAC3C,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAgB,gCAE7B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,2EAAsE,CAAC,EACvE,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAgB,gDAE7B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,+FAA0F,CAAC,EAC3F,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAgB,4EAI7B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,0CAAqC,CAAC,EACtC,IAAA7B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAgB,0EAI7B,CAAM,CACC,CAAC;AAChB;AACA;AACAN,UAAU,CAACO,cAAc,GAAG,IAAI","ignoreList":[]}

package/dist/preview-1755618052181.js

@@ -0,0 +1,7 @@
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.pkg_aspect-docs_pkg@96af1a186d7e33351b25fd4a290b75653da81de6/dist/pkg.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.pkg_aspect-docs_pkg@96af1a186d7e33351b25fd4a290b75653da81de6/dist/pkg.docs.mdx';
+
+export const compositions = [compositions_0];
+export const overview = [overview_0];
+
+export const compositions_metadata = {"compositions":[{"displayName":"Pkg docs","identifier":"PkgDocs"}]};

package/index.ts

@@ -0,0 +1 @@
+export { default as Pkg } from './pkg.mdx';

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@teambit/pkg.aspect-docs.pkg",
+  "version": "0.0.0-96af1a186d7e33351b25fd4a290b75653da81de6",
+  "homepage": "https://bit.cloud/teambit/pkg/aspect-docs/pkg",
+  "main": "dist/index.js",
+  "componentId": {
+    "scope": "teambit.pkg",
+    "name": "aspect-docs/pkg",
+    "version": "96af1a186d7e33351b25fd4a290b75653da81de6"
+  },
+  "dependencies": {
+    "core-js": "^3.0.0",
+    "@mdx-js/react": "1.6.22",
+    "@teambit/mdx.ui.mdx-scope-context": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^17.0.8",
+    "@types/mocha": "9.1.0",
+    "@types/node": "12.20.4",
+    "@types/react-dom": "^17.0.5",
+    "@types/jest": "^26.0.0",
+    "@babel/runtime": "7.20.0",
+    "@types/testing-library__jest-dom": "5.9.5",
+    "@teambit/documenter.theme.theme-compositions": "4.1.5",
+    "@teambit/mdx.ui.mdx-layout": "1.0.11"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0"
+  },
+  "license": "Apache-2.0",
+  "optionalDependencies": {},
+  "peerDependenciesMeta": {},
+  "private": false,
+  "engines": {
+    "node": ">=12.22.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teambit/bit"
+  },
+  "keywords": [
+    "bit",
+    "components",
+    "collaboration",
+    "web",
+    "react",
+    "react-components",
+    "angular",
+    "angular-components"
+  ]
+}

package/pkg.composition.tsx

@@ -0,0 +1,12 @@
+import React from 'react';
+import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
+import { MDXLayout } from '@teambit/mdx.ui.mdx-layout';
+import { Pkg } from './index';
+
+export const PkgDocs = () => (
+  <ThemeCompositions>
+    <MDXLayout>
+      <Pkg />
+    </MDXLayout>
+  </ThemeCompositions>
+);

package/pkg.docs.mdx

@@ -0,0 +1,34 @@
+---
+description: 'Docs for Pkg aspect'
+labels: ['docs', 'aspect', 'extensions']
+---
+
+import { Pkg } from './index';
+
+## Static Content Page in Pkg
+
+Docs for Pkg aspect
+
+### Component usage
+
+Use your component in any Pkg file:
+
+```js
+import { Pkg } from '@teambit/aspect-docs.pkg';
+
+<Pkg />;
+```
+
+### Render with theme and Pkg providers
+
+```js
+import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
+import { PkgLayout } from '@teambit/ui.Pkg-layout';
+import { Pkg } from '@teambit/aspect-docs.pkg';
+
+<ThemeCompositions>
+  <PkgLayout>
+    <Pkg />
+  </PkgLayout>
+</ThemeCompositions>;
+```

package/pkg.mdx

@@ -0,0 +1,184 @@
+Bit components can be thought of as a super-set of standard packaged node modules.
+Each component contains a consumable package in addition to its documentation, history and other information that enables it to be independently developed and maintained.
+
+The PKG aspect handles the configuration, publishing and packing of component packages.
+It adds its own build task to the build pipeline, to create component packages and include them in as part of the component artifacts.
+This automation includes generating the package name and other properties according to the component's details.
+
+#### Features
+
+- **Efficient `package.json` configuration:** Use the PKG's workspace config API to add or override `package.json` properties to a group of components, all at once.
+  Use PKG's 'placeholders' to integrate component-specific data into the component's package configurations.
+- **An API for programmable `package.json` configuration:** Use PKG's API to provide your extensions with "packaging capabilities". Modify the `package.json` to suit your extension's needs, whether it is an environment or any other type of extension.
+- **Automated packing and publishing:** - PKG is registered to your build pipeline. That means every 'build' will also test 'packing' and every tagging of a new release version will also include 'publishing'. Your components and packages versions are alway in-sync.
+- **"On-demand" packing and publishing:** - PKG offers the `pack` and `preview` CLI commands for a manual and on-demand usage.
+
+### Quickstart & configuration
+
+> This aspect is only configurable using the 'variants' workspace API.
+
+#### Package properties
+
+Use the `packageJson` property to add or override the default `package.json` for your component packages.
+
+> Warning! Packages with a modified `name` property will not be published to Bit.dev's registry.
+
+```js
+{
+  "ui/*": {
+    "teambit.pkg/pkg": {
+      "packageJson": {
+          "name": "@{scope}/{name}",
+          "private": false,
+          "main": "dist/{main}.js",
+          "custom-prop": "value"
+      }
+    }
+  }
+}
+```
+
+#### Publish
+
+> If `publishConfig` or `name` are not set, packages will be published to Bit.dev's registry.
+
+##### npm arguments
+
+You can specify additional arguments to the `npm publish` command by adding an array of args to `packageManagerPublishArgs`.
+
+For example:
+
+```js
+"ui/*": {
+  "teambit.pkg/pkg": {
+    "packageManagerPublishArgs": ["--access public"]
+  }
+}
+```
+
+#### npmjs Registry
+
+- Use the `name` property to set the publishing process to your [npm scope](https://docs.npmjs.com/cli/v6/using-npm/scope).
+- Use the `private` _(boolean)_ property to set packages to be published with either private or public access.
+
+```js
+{
+  "ui/*": {
+    "teambit.pkg/pkg": {
+      "packageJson": {
+          "name": "@{scope}/{name}",
+          "private": false,
+      }
+    }
+  }
+}
+```
+
+- By default, when specifying `name` or `publishConfig`, it'll publish to NPM. In some rare cases, this is not desired, to cancel it, add the config `"avoidPublishToNPM": true`
+
+#### Private registry
+
+Use the `scope` and `registry` properties to configure the publishing process to your own private registry (and scope).
+
+```js
+"ui/*": {
+  "teambit.pkg/pkg": {
+    "packageJson": {
+       "publishConfig": {
+         "scope": "@custom",
+         "registry": "http://localhost:4873"
+      }
+    }
+  }
+}
+```
+
+> Packages with a modified `publishConfig` property will not be published to Bit.dev's registry.
+
+#### Placeholders
+
+Placeholders are an easy way to inject component-specific information into the 'pkg' configurations.
+
+- `{name}` - The name of the component.
+- `{scope}` - The name of the component scope.
+- `{main}` - the name of the main file (leaving out the extension) - for example `index.js` will be `index`.
+
+For example:
+
+```js
+ "packageJson": {
+    "main": "dist/{main}.js"
+  }
+```
+
+#### .npmignore
+
+Add records to the .npmignore file before a package is published or pack.
+For example, if you don't want the source files to be part of the package, you can add them to the .npmignore.
+
+The API to add records to this file is exposed in the environment: `getNpmIgnore()`.
+
+For example, the following was added to the Aspect env.
+
+```js
+getNpmIgnore() {
+  // ignores only .ts files in the root directory, so d.ts files inside dists are unaffected.
+  return ['/*.ts']
+}
+```
+
+### CLI Reference
+
+#### Pack
+
+Creates a TAR file (to be published to a node package registry):
+
+```shell
+bit pack <component-id>
+```
+
+Overrides the existing TAR file (in the same location):
+
+```shell
+bit pack <component-id> --override
+
+bit pack <component-id> -o
+```
+
+Returns the output in a JSON format:
+
+```shell
+bit pack <component-id> --json
+
+bit pack <component-id> -j
+```
+
+#### Publish
+
+Publishes an exported component:
+
+```shell
+bit publish <componentId>
+```
+
+Publishes a staged component that has not yet been exported:
+
+```shell
+bit publish <component-id> --allow-staged
+```
+
+Checks if the publishing process will be done successfully (without publishing):
+
+```shell
+bit publish <component-id> --dry-run
+
+bit publish <component-id> -d
+```
+
+Returns the output as JSON:
+
+```shell
+bit publish <component-id> --json
+
+bit publish <component-id> --j
+```

package/types/asset.d.ts

@@ -0,0 +1,29 @@
+declare module '*.png' {
+  const value: any;
+  export = value;
+}
+declare module '*.svg' {
+  import type { FunctionComponent, SVGProps } from 'react';
+
+  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  const src: string;
+  export default src;
+}
+
+// @TODO Gilad
+declare module '*.jpg' {
+  const value: any;
+  export = value;
+}
+declare module '*.jpeg' {
+  const value: any;
+  export = value;
+}
+declare module '*.gif' {
+  const value: any;
+  export = value;
+}
+declare module '*.bmp' {
+  const value: any;
+  export = value;
+}

package/types/style.d.ts

@@ -0,0 +1,42 @@
+declare module '*.module.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.mdx' {
+  const component: any;
+  export default component;
+}