question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Site with documentation and preview of the components

See original GitHub issue

Hi,

I have created a repository that is a Angular 2 application that displays the documentation of Angular 2 Material simply because there was no site present of that kind. The documentation is just the README.md files found in each component found here as well as the core folders documentation. I have just generated HTML files from those markdown files and added some Angular components which displays the html. The repository can be found here and the site here.

I would gladly make a pull request to be added to the material2 repository if you think this is a good idea and good fit. If you do not think so, would I like to keep it in the repository where it is today or if you do not want that either I would have no problem removing the repository and the site if you want that.

I would gladly continue to work on it if you think it is a good idea.

Please let me know what you think.

Thank you!

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Reactions:7
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
ErmansMCcommented, Jul 6, 2016
0reactions
angular-automatic-lock-bot[bot]commented, Sep 5, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

Read more comments on GitHub >

github_iconTop Results From Across the Web

6 Tools for Documenting Your React Components Like a Pro
Tools for documenting React UI components in 2019. Document components with Bit, StoryBook, StyleGuidist, Docz, MDX-docs, React docgen and ...
Read more >
Web Components - MDN Web Docs - Mozilla
Web Components is a suite of different technologies allowing you to create reusable custom elements — with their functionality encapsulated ...
Read more >
How to document components - Storybook
Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and...
Read more >
Preview Your Components from Visual Studio Code
In your project, right-click your component folder and select SFDX: Preview Component Locally. In the Command Palette, enter preview component , and select ......
Read more >
Sanity Custom Preview Component to get Parent Document
In this example, we created a custom PreviewComponent page to get the Index of an array item inside the object using the parent...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found