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

docs: add examples #334

Merged
merged 6 commits into from
Jun 4, 2024
Merged

docs: add examples #334

merged 6 commits into from
Jun 4, 2024

Conversation

Barbapapazes
Copy link
Member

@Barbapapazes Barbapapazes commented Nov 5, 2023

πŸ”— Linked issue

related to #219

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

I create a lot of simple examples to show how to use unbuild.

For untyped, I think there is a bug, see #333
For mkdist, there is a type issue, see #332

For transpiling json or html to esm, there is an error when also having an index.ts file. I do not know if this is a bug or if I am doing something wrong.

I could also add an example for inlining deps?

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@Barbapapazes Barbapapazes added the documentation Improvements or additions to documentation label Nov 5, 2023
@Barbapapazes Barbapapazes self-assigned this Nov 5, 2023
@Barbapapazes Barbapapazes requested a review from pi0 November 5, 2023 21:24
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thanks (and sorry for all delays).

In order to iterate I've simplified examples into 3: zero config, mkdist and untyped

@pi0 pi0 merged commit 648b9b4 into main Jun 4, 2024
2 checks passed
@pi0 pi0 deleted the docs/examples branch June 4, 2024 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants