Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples #7

Merged
merged 2 commits into from
Aug 31, 2023
Merged

Examples #7

merged 2 commits into from
Aug 31, 2023

Conversation

ryepup
Copy link
Collaborator

@ryepup ryepup commented Aug 31, 2023

Proposed changes

Add some examples for how to use reference-lib, namely the reference browser that seemed useful in our previous experiments.

Some of the reference-lib usage is a little clumsy, might be space for different APIs to access the data.

Started from npm create vite@latest, so brought in a bunch of structure. Tried to minimize the dependencies and focus on functionality. There's plenty of room for improvement in the styling.

Had to make a few tweaks in reference-lib:

  • ignore the dist folder in more tools
  • rollup to an es module (the default) instead of common js. I was getting import errors with the cjs version.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md and CHANGELOG.md)

examples/README.md Outdated Show resolved Hide resolved
@ryepup ryepup force-pushed the examples branch 2 times, most recently from 02d8238 to 008b769 Compare August 31, 2023 17:58
`npm create vite@latest ref-browser -- --template react-ts` with a few tweaks
Ports one of our useful experiments on top of the `reference-lib`, a few react components to show the directives easily.

Some of the `reference-lib` usage is a little clumsy, might be space for different APIs to access the data.

Started from `npm create vite@latest`, so brought in a bunch of structure. Tried to minimize the dependencies and focus on functionality. There's plenty of room for improvement in the styling.

Had to make a few tweaks in `reference-lib`:

- ignore the `dist` folder in more tools
- rollup to an es module (the default) instead of common js. I was getting import errors with the `cjs` version.
@ryepup ryepup merged commit dd6831d into main Aug 31, 2023
1 check passed
@ryepup ryepup deleted the examples branch August 31, 2023 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants