radio4000 / components

web-components to build the r4 interfaces, uses the sdk
https://components.radio4000.com/
1 stars 0 forks source link

Docs test #165

Closed oskarrough closed 5 months ago

oskarrough commented 6 months ago

Experimenting how we could add more API docs for the components.

Currently r4-docs renders the manifest twice in two different styles. First is copy/pasted/adapted from the lit-starter template. Second is just a quick <pre> tag.

More thoughts..

Do we want r4-docs inside src/components instead? Is /docs.html cool? Do we even want this or something completely different? With the current styles it's pretty unreadable. Thinking about it, we could also use eleventy or something to quickly generate static docs. Then no JS is needed. I don't mind either way.

oskarrough commented 5 months ago

I think it's kinda cool now. Still it should probably have been a static site instead. Locally check the /docs.html page.

Re-generate the manifest with npm run manifest.