daffodil icon indicating copy to clipboard operation
daffodil copied to clipboard

[FEAT] Display Example Viewer in Markdown Files

Open xelaint opened this issue 1 year ago • 1 comments

:bulb: Feature request

Feature Name

Display Example Viewer in Markdown Files

The Desired Behavior

  • [ ] Extract DesignLandExampleViewerContainer into docs-utils
  • [ ] Add support to daff.io for DesignLandExampleViewerContainer

Your Use Case

As a designer and developer, I expect the example viewer in component markdown files to be visible.

As seen in the screen shots, the <design-land-example-viewer-container> is added to the readme for card. It's not visible on next.daff.io/docs/packages/design/card, but it's shown in the dom when you inspect the page.

Screen Shot 2024-07-08 at 2 16 22 PM Screen Shot 2024-07-08 at 2 16 41 PM Screen Shot 2024-07-08 at 2 18 08 PM

Prior Work

Environment


Daffodil version: X.Y.Z
Angular version: X.Y.Z 

 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

xelaint avatar Jul 08 '24 20:07 xelaint

the current method of displaying examples relies on custom elements. Because daffio has SSR, this breaks as Angular does not support custom elements. I'm fairly sure that I can implement a solution that does not rely on CEs but I'm wondering if I should just wait in favor of #2902

griest024 avatar Jul 09 '24 20:07 griest024