[ANNOUNCEMENT] Examples for packages

[antfu]

Hi guys. From wyg 0.2.2, we supported a new field examples for your packages.

You can now specify examples' names in registry-packages.ts

For example:

wyg-registry/registry-packages.ts

Lines 36 to 46 in f050c6f

	{
	name: '子曰',
	repo: 'antfu/ziyue-wy',
	description: 'Cowsay for wenyan-lang',
	author: {
	name: 'antfu',
	url: 'https://github.com/antfu',
	},
	aliases: ['ziyue'],
	examples: ['例一'],
	},

It will refer to https://github.com/antfu/ziyue-wy/blob/master/例一.wy

Then users will see the examples in our Online IDE

Feel free to add examples for your packages! Cheers!

cc @lymslive @akira-cn @GLanguage @alainsaas @xingzilong

[GLanguage]

Great! But does it mean that we have to reinstall the packages in order to get the examples?

[antfu]

does it mean that we have to reinstall the packages in order to get the examples?

In the Online IDE, there is no need to reinstall. The IDE will fetch the latest packages info and only download scripts when users import them.

For local installation by wyg install xx, yes, people need to reinstall packages to get the examples. But since the examples do not affect the packages code, unless you do need to download the examples to your disk, there is no need to reinstall.

[GLanguage]

OK, thanks. And examples are added :P