We are proud to announce the immediate availability of the first version of css_doc. It is a tool to extract Javadoc-like documentation from CSS files. It was inspired by the work from the CSSDOC guys, but is NOT a complete implementation of their proposed standard. It is, however, quite similar, so that your existing CSSDOC documentation should probably work with css_doc.
This is the first release, so it is not what one would call “feature-complete”, but it is already quite stable at the moment. This version’s features include:
- File-level documentation for each CSS file in your project.
- Possibility to divide a single file into multiple sections.
- Rule-set-level documentation (a rule set is a set of selectors, separated by commas, together with their CSS properties).
- HTML-Code examples for the usage of your CSS rules are extracted. This is useful for building a style guide.
- Generates selector, section and file index pages.
For an example, please have a look at http://opensource.imedo.de/css_doc/index.html. The documented CSS file can be found here: http://opensource.imedo.de/stylesheets/style.css. I know the design of the css_doc documentation is not pretty, but we will improve on that in a future release.
If you like css_doc and are a Ruby hacker, or if you would like to improve the default design, please fork the project on github and send us a pull request. Of course the code contains lots of tests, but you are also welcome to add more tests, especially if you find bugs.
For installation instructions, please see http://github.com/imedo/css_doc.
Popularity: 7% [?]