michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[ci] yarn format

Browse source
This commit is contained in:
natemoo-re 2021-06-07 14:41:07 +00:00 committed by GitHub Actions
parent be0fe0e908
commit f6da8b8571
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/publishing.md
View file

@ -34,14 +34,14 @@ Here's an example project with a couple of components.
└── bold.astro └── bold.astro
``` ```
Where __index.js__ looks like this: Where **index.js** looks like this:
```js ```js
export { default as Capitalize } from './capitalize.astro'; export { default as Capitalize } from './capitalize.astro';
export { default as Bold } from './bold.astro'; export { default as Bold } from './bold.astro';
``` ```
In your __package.json__ define an [exports entry](https://nodejs.org/api/packages.html) like so: In your **package.json** define an [exports entry](https://nodejs.org/api/packages.html) like so:
```json ```json
{ {
@ -67,7 +67,7 @@ Above we created an index file that re-exports our components, which gives us th
However you can also import published `.astro` files directly, in the same manner that you import `.astro` files in your own project. However you can also import published `.astro` files directly, in the same manner that you import `.astro` files in your own project.
Change the above __package.json__ to this: Change the above **package.json** to this:
```json ```json
{ {
@ -81,7 +81,7 @@ Change the above __package.json__ to this:
} }
``` ```
The `"."` is used to signify the package's main module. We set it to the __index.js__ file to allow the import method shown above. The `"."` is used to signify the package's main module. We set it to the **index.js** file to allow the import method shown above.
Adding `"./bold.astro"` and `"./capitalize.astro"` to the exports field also allows consumers to import the components directly, by file name, like so: Adding `"./bold.astro"` and `"./capitalize.astro"` to the exports field also allows consumers to import the components directly, by file name, like so: