unbuild icon indicating copy to clipboard operation
unbuild copied to clipboard

Improve build option docs

Open ederzz opened this issue 2 years ago • 11 comments
trafficstars

Describe the feature

Could u add some docs has more details with build options? In readme, I could find options in types, but don't get their meaning.

Additional information

  • [ ] Would you be willing to help implement this feature?

ederzz avatar Feb 17 '23 02:02 ederzz

Linking https://github.com/unjs/unbuild/issues/210 and https://antfu.me/posts/publish-esm-and-cjs#bundling

pi0 avatar Jul 18 '23 16:07 pi0

Would be very useful also the usage of rollup plugins with in unbuild, It's pretty tricky and hidden if you're new to the package

D4RKAR117 avatar Jul 22 '23 22:07 D4RKAR117

Describe the feature

Could u add some docs has more details with build options? In readme, I could find options in types, but don't get their meaning.

Additional information

  • [ ] Would you be willing to help implement this feature?

Hello, thanks for reporting this! I will work on it!

Barbapapazes avatar Nov 05 '23 20:11 Barbapapazes

May I ask why this document has not been pushed forward? As mentioned above, there are many configurations that cannot understand its meaning. I don't even know what functions he can have. 🤔


I can provide assistance for this, if you are willing.

RSS1102 avatar Jan 21 '24 20:01 RSS1102

Hey, what do you mean by document?

Barbapapazes avatar Jan 21 '24 22:01 Barbapapazes

What are the configurations in buildonfig and what is the purpose of each configuration.

As he said:

Could u add some docs has more details with build options? In readme, I could find options in types, but don't get their meaning.

RSS1102 avatar Jan 21 '24 22:01 RSS1102

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it.


Perhaps using vitepress?

RSS1102 avatar Jan 22 '24 15:01 RSS1102

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it.

Perhaps using vitepress?

The first thing to do is to add some comments to document there types. Actually, there is no need for a full documentation.

Barbapapazes avatar Jan 22 '24 15:01 Barbapapazes

ok, i will try it frist.

RSS1102 avatar Jan 22 '24 15:01 RSS1102

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it. Perhaps using vitepress?

The first thing to do is to add some comments to document there types. Actually, there is no need for a full documentation.

#363 But it seems a bit messy for the code files. Perhaps there should be some descriptions of packson or build.config.ts

RSS1102 avatar Jan 23 '24 18:01 RSS1102

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it. Perhaps using vitepress?

The first thing to do is to add some comments to document there types. Actually, there is no need for a full documentation.

#363 But it seems a bit messy for the code files. Perhaps there should be some descriptions of packson or build.config.ts

Will take a look

Barbapapazes avatar Jan 23 '24 19:01 Barbapapazes