eightequal/AstralRinth
1
0
Fork 0
forked from didirus/AstralRinth
Code Pull Requests Activity

Refactor folder structure

Browse Source
This commit is contained in:
venashial
2022-06-17 19:58:01 -07:00
parent 8204139df8
commit 137fbb638b
110 changed files with 45 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -10,7 +10,7 @@ Requires Node v16.5+.
## Developing
The library lives in the `src/package` folder, and the documentation lives in the `src/routes` folder.
The library lives in the `package/` folder, and the documentation lives in the `docs/` folder.
```bash
pnpm install # Install dependencies
@@ -21,12 +21,12 @@ pnpm dev # Run dev server
> Replace `ComponentName` with your component name in the steps below
1. Create a `ComponentName.svelte` file in `src/package/components`
2. Add an export for your component in [./src/package/index.ts](./src/package/index.ts)
1. Create a `ComponentName.svelte` file in `package/components`
2. Add an export for your component in [./package/index.ts](./package/index.ts)
```
export { default as ComponentName } from './components/ComponentName.svelte'
```
3. Create a `ComponentName.md` file for documentation in `src/routes/components`
3. Create a `ComponentName.md` file for documentation in `docs/routes/components`
4. Add an example of your component in your `ComponentName.md` file, like so:
````md