Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] Display Example Viewer in Markdown Files #2903

Closed
2 tasks
Tracked by #1925
xelaint opened this issue Jul 8, 2024 · 1 comment · Fixed by #2909
Closed
2 tasks
Tracked by #1925

[FEAT] Display Example Viewer in Markdown Files #2903

xelaint opened this issue Jul 8, 2024 · 1 comment · Fixed by #2909
Assignees
Labels
docs This issue is related to documentation feat a new feature, enhancement, or improvement p1 critical priority
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Jul 8, 2024

💡 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 xelaint added feat a new feature, enhancement, or improvement docs This issue is related to documentation labels Jul 8, 2024
@xelaint xelaint added this to the Daffodil v1.0 milestone Jul 8, 2024
@xelaint xelaint mentioned this issue Jul 8, 2024
24 tasks
@xelaint xelaint added the p1 critical priority label Jul 9, 2024
@griest024
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation feat a new feature, enhancement, or improvement p1 critical priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants