https://github.com/evidence-dev/labs
Experimental components and features for Evidence.
https://github.com/evidence-dev/labs
Last synced: about 1 year ago
JSON representation
Experimental components and features for Evidence.
- Host: GitHub
- URL: https://github.com/evidence-dev/labs
- Owner: evidence-dev
- Created: 2023-06-08T17:18:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-25T22:41:46.000Z (over 2 years ago)
- Last Synced: 2023-10-25T23:26:26.652Z (over 2 years ago)
- Language: Svelte
- Homepage: https://labs.evidence.dev
- Size: 1.54 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Evidence Labs
Evidence labs contains experiemental components and features for [Evidence](https://evidence.dev) projects.
To install Evidence
```bash
npx degit evidence-dev/template my-project
cd my-project
npm install
npm run dev
```
## Using Evidence Labs Components
1. Install the package from npm:
```bash
npm install --save @evidence-dev/labs
```
2. Include it in your `evidence.plugins.yaml` file:
```yaml
components:
@evidence-dev/core-components: {}
@evidence-dev/labs: {}
```
3. Add the component to your page!
Ensure you restart your dev server after adding the plugin!
## Build your own plugin
1. Clone this repository
2. Add your components to the `src/lib` directory
3. Test they work by adding them to a page in the `pages/` directory
4. Edit the name in `package.json` from `@evidence-dev/labs` to `your-plugin-name` and set the version to `0.0.1`
5. Publish to npm with `npm publish` (You will need to be logged in to an [npm](https://www.npmjs.com/signup) account)