Demo: Look into an approach to include usage notes on a components demo page

GetTerminus / terminus-ui

📚 The Terminus UI Library.

MIT License

53 stars 8 forks source link

Demo: Look into an approach to include usage notes on a components demo page #1208

Open benjamincharity opened 5 years ago

benjamincharity commented 5 years ago

Need

Allow UX to define usage notes (dos/don'ts) for each component.

Requirements

[ ] Notes should be written with Markdown
[ ] Images should be supported
[ ] Notes are converted to HTML and injected below each demo

Needs:

[ ] Find a good markdown-to-html library
[ ] Determine how to compile markdown and inject as part of the build process
[ ] ____?

Note: This is a temporary solution until the official site replaces our demos site.

dpeet commented 5 years ago

What do you think about including gifs of usage as well? I know you've had them in your tickets (famous example https://github.com/GetTerminus/terminus-ui/pull/980) and they're a great way to see the full interaction

In general I think it would be beneficial to have more visual documentation of how the component can be used (and for our future site, being able to play with all the different states of course is a goal)

dpeet commented 5 years ago

this is what I was referencing for MD https://medium.com/@david.dalbusco/add-a-blog-to-your-angular-website-using-markdown-files-31cdb0627bdd

benjamincharity commented 5 years ago

Yep. I've got image support as one of our needs.