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

Example #44

Open
peterbsmyth opened this issue Jun 13, 2020 · 2 comments
Open

Example #44

peterbsmyth opened this issue Jun 13, 2020 · 2 comments

Comments

@peterbsmyth
Copy link

peterbsmyth commented Jun 13, 2020

Getting started

I compiled snippets of source from three places:

  • storybook's preview component
  • the svelte-docs source code
  • angular documentation's example-viewer

the lightly annotated code is here.

Notes

...the angular example-viewer is a tightly-coupled system. Angular docs use a pre-processor, i haven't located that source code, that uses a method similar to svelte-docs for processing markdown.
...the example-viewer can only show examples from a source that is in an angular namespace @angular/component-examples that makes it possible to define an example to display based on a predefined string key. the inline usage in a markdown file looks like:

<!-- example(cdk-drag-drop-overview) -->

...the svelte markdown preprocessor that is a part of the svelte-docs project is a small amount of code.

...the react project couples the style. it is the only project whose props allow for style to be passed in using a className prop. as well, it shares with the angular example-viewer an expandable/collapsible prop.

@jamespatrickgibson
Copy link
Owner

I think I'm going to open up a new branch in the project specifically to explore this component a bit

@jamespatrickgibson
Copy link
Owner

#45

WIP for example component here

@jamespatrickgibson jamespatrickgibson linked a pull request Jun 16, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants