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

Site with documentation and preview of the components #818

Closed
drager opened this issue Jul 5, 2016 · 6 comments
Closed

Site with documentation and preview of the components #818

drager opened this issue Jul 5, 2016 · 6 comments

Comments

@drager
Copy link
Contributor

drager commented Jul 5, 2016

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!

@eserlan
Copy link

eserlan commented Jul 5, 2016

+1

@ErmansMC
Copy link

ErmansMC commented Jul 6, 2016

+1
You can also add these links: https://github.com/angular/material2/wiki/Design-doc-directory

@jonathan-casarrubias
Copy link

Really nice!

@jelbourn
Copy link
Member

jelbourn commented Jul 6, 2016

@drager Thanks for making this! We have people working on our docs site for https://material.angular.io, but this is a nice site for people to look at in the interim.

@jelbourn jelbourn closed this as completed Jul 6, 2016
@drager
Copy link
Contributor Author

drager commented Jul 6, 2016

@Ermans: Will do that! Great idea.

@jelbourn: Ah alright, then I will continue to work on it and fix things until the official site is ready. Please let me know if you are in the need of any help at all for that site. Thanks

@angular-automatic-lock-bot
Copy link

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.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants