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: render design examples in daffio #2909

Merged

Conversation

griest024
Copy link
Member

@griest024 griest024 commented Jul 12, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #2903

What is the new behavior?

  • moves the example viewer components to a docs-components package
  • changes the example rendering from a custom element based one to a component outlet one
  • adds custom element support for the example viewer container so it can be rendered when the markdown is rendered with innerHtml
  • converts example components to standalone so that they can be dynamically rendered
  • extracts internal package ignore constant in dgeni and adds new packages

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

- moves the example viewer components to a `docs-components` package
- changes the example rendering from a custom element based one to a component outlet one
- adds custom element support for the example viewer container so it can be rendered when the markdown is rendered with `innerHtml`
- converts example components to standalone so that they can be dynamically rendered
- extracts internal package ignore constant in dgeni and adds new packages
@griest024 griest024 requested a review from xelaint July 12, 2024 18:48
@griest024 griest024 self-assigned this Jul 12, 2024
@griest024 griest024 requested review from a team as code owners July 12, 2024 18:48
@griest024 griest024 removed their assignment Jul 12, 2024
@griest024 griest024 added docs This issue is related to documentation package: daff.io @daffodil/daff.io package: design @daffodil/design status: awaiting review This PR is awaiting review package: docs-utils @daffodil/docs-utils tools: dgeni @daffodil/tools-dgeni labels Jul 12, 2024
@griest024
Copy link
Member Author

@xelaint Can you acceptance test that design-land and daffio look correct to you?

@griest024 griest024 merged commit 6bba42d into graycoreio:develop Jul 16, 2024
17 checks passed
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 package: daff.io @daffodil/daff.io package: design @daffodil/design package: docs-utils @daffodil/docs-utils status: awaiting review This PR is awaiting review tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEAT] Display Example Viewer in Markdown Files
2 participants