docs(ComponentExample): automatically read code

[KeJunMao]

🔗 Linked issue

link #733

❓ Type of change

• 📖 Documentation (updates to the documentation or readme)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality)
• ✨ 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

📝 Checklist

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
ui	✅ Ready (Inspect)	Visit Preview	Oct 9, 2023 8:45am

[MuhammadM1998]

Thanks a lot I've been struggling with this while trying to learn about the codebase. One note is the button still shows only the padded prop and misses the icon="i-heroicons-x-mark-20-solid" as written in the source code. The button content file isn't changed in this PR so maybe you plan to update it later. Thanks again 🙏

[KeJunMao]

Hi @MuhammadM1998 , The button component uses content/ComponentCard.vue, and this PR only supports content/ComponentExample.vue

[MuhammadM1998]

Yes I saw that when I looked at the code and thought you'll refactor it too to use ComponentExample, maybe ask benjamin if this is a good idea?

[KeJunMao]

Let's wait for benjamin's suggestion for this PR first. 😀

[benjamincanac]

Why did you comment this?

[KeJunMao]

China sometimes blocks github, so i disabled github driver in local develop，I apologize that forgot to clean up it.

[benjamincanac]

No worries 😊

[benjamincanac]

Truly awesome PR, this will remove so much markdown code and make it so much easier to maintain, thanks a lot! 😊

I think we can merge this first and then solve the ComponentCard issue.

It was intentional to hide some props or tailwind classes to have clean examples at first but I guess it can be quite annoying when copy-pasting the code-blocks indeed.

[benjamincanac]

Did you exclude some :component-example refactor on purpose? I still some with the old behaviour in table.md and command-palette.md.

[benjamincanac]

Thanks a lot! 😊

[benjamincanac]

@KeJunMao Do you plan to work on the ComponentCard now? My guess for this is we just need to remove the baseProps and put everything into props to solve #733, right?

[KeJunMao]

let me do it!