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

feat: deploy basic schema viewer using vite #257

Merged
merged 4 commits into from
Oct 16, 2024

Conversation

jamdelion
Copy link
Contributor

@jamdelion jamdelion commented Oct 15, 2024

In this PR:

  • Added the /docs folder containing a vite+react-ts project featuring @stoplight/json-schema-viewer
  • Turned /schemas into its own package so it can be imported into the /docs project.
  • Added a GH action that should deploy when there are pushes to main.

More context

Once this is merged I will check that it behaves the same in this repo! 🤞

Comment on lines +54 to +55
// const _applicationTypeProperty =
// '$data.application.type.description' || '$applicationType';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eslint complained about unused variables so have commented out for now.

@jamdelion jamdelion marked this pull request as ready for review October 15, 2024 13:56
@jamdelion jamdelion requested a review from a team October 15, 2024 13:57
Copy link
Member

@jessicamcinchak jessicamcinchak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow excellent config work this looks so promising!

A few minor comments from first read through - working my way through other repo too to check out deployment then will come back here for final review 🙂

docs/src/schemas.d.ts Outdated Show resolved Hide resolved
docs/package.json Outdated Show resolved Hide resolved
pnpm i
pnpm link ../schemas
pnpm build
ls -R
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pnpm link is clever solution here! 💡

.github/workflows/push.yml Outdated Show resolved Hide resolved
@@ -0,0 +1,10 @@
import 'prismjs';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀 ahaa this top-level import prismjs! The relationship between & config required for the core prism lib versus vite prism plugin was stumping me hard, great find 🙌

@jamdelion jamdelion merged commit 1dac923 into main Oct 16, 2024
3 checks passed
jessicamcinchak added a commit that referenced this pull request Oct 17, 2024
@jessicamcinchak jessicamcinchak deleted the jh/deploy-vite-schema-docs branch October 30, 2024 14:35
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.

2 participants