Demo please
Closed this issue · 6 comments
this sounds promising, is there a demo to see a styleguide in action?
There are some demos inside the examples directory of this repo, just run the index.js node script to generate the style guide. The FamilySearch.org Style Guide is also using it with a custom Handlebars template. It's parsing the comments from this repo.
Ah! The FamilySearch.org Styleguide helped me to see what this tool is doing. thank you very much!
This is fantastic work. I do agree, however, that you'd probably want to make the demo (in this case the FamilySearch.org SG) more prominent in the readme, and by that I mean add it at the top. One of the first things I do when I look at these types of tools is go see a demo and see if it even looks remotely close to what I'm after. By not putting that link in the readme I think you're possibly losing a lot of people that don't want to read a long page of documentation without knowing what it will actually output.
Good point. I'll add it to the repo and probably also create a github page that shows off the default template.
Readme has been updated with two demos.
Awesome, I think that's extremely helpful!