https://github.com/Joony/styledoc
https://github.com/Joony/styledoc
Last synced: about 15 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/Joony/styledoc
- Owner: Joony
- Created: 2012-01-09T16:25:26.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2012-02-03T10:40:36.000Z (almost 14 years ago)
- Last Synced: 2024-05-19T05:27:02.399Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 148 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- fucking-awesome-css - Styledoc
- awesome-css - Styledoc
README
# Styledoc
A standard for documenting and building your object-/module-oriented cascading stylesheets. The documentation syntax is based on JavaDoc and hopefully will allow the Styledoc parser to create a styleguide on-the-fly.
Now that's brown sugar for your Irish coffee right there.
Build by [@joony](http://twitter.com/joony) and [@laustdeleuran](http://twitter.com/laustdeleuran) at [@verticny](http://twitter.com/verticny).
## To-do / known issues / wish list
* Think up clever way to do sections and subsections, parse them accordingly and output them on "pages"
* Test with more demanding modules, especially with nested markup
* How do nested modules act?
* Think of how the interface for developers should be. How do you use hte library? Is the OOP approach the right one - or is there no way you'd need more than one instance? And if so, why shouldn't it take over the entire page?
* What about baseline styling? Restes, fonts, body/html backgrounds etc.? Do we toatlly disregard that?