YUIDoc 0.3.0 is Official!
[View Larger Image]
[View Larger Image]
- Live previews. YUIDoc includes a standalone doc server, making it trivial to preview your docs as you write.
- Wide language support. YUIDoc was originally designed for the YUI project, but it is not tied to any particular library or programming language. You can use it with any language that supports
/* */comment blocks.
- Markdown support in code comments
- Support for many more tags out of the box
- Logic separated to allow for easy extensibility
- Better theming support
- Server mode for development time previews
- External data mixing
- Easy cross platform installation
- Cross-linking inside and out of current project
- JSON based configuration
Simple InstallationIf you have Node.js and NPM installed, installation is easy:
npm -g install yuidocjs
Markdown support in code commentsYUIDoc will parse your comment with Markdown before it applies the Handlebars template giving you great flexibility when writing your docs.
Logic separated to allow for easy extensibilityYUIDoc uses YUI's class infrastructure internally and exports all of these modules when you
yuidocjsmodule. This allows end users to hook into YUIDoc's internals and change the way it does things. You can extend classes, augment them or just flat out change methods to suite your needs.
Better theming supportIn this release we use the built-in
Y.Handlebarshelper to handle all template generation. We have also taken development into consideration when building this feature. YUIDoc will first search it's built in theme directory for partials, then it will search your local theme directory. This allows you to only have to maintain the files you wish to change in your theme and not have to copy every partial even if you are not modifying it.
Server mode for development time previewsThis is my favorite new feature! You can fire up YUIDoc in server mode and it will give you live previews of your documentation as you edit it. Simply save your file and reload the page from the built in server and see your changes live. Including external data and cross-linking. You no longer have to generate the docs for your entire project just to see a documentation change!
External data mixingYUIDoc now allows you to link your documentation to the rendered output from another YUIDoc instance. For example, if your project is using YUI and extending some of our core classes, you can link to our exported
data.jsonfile (from our YUIDoc build) and when YUIDoc parses your documentation it will fetch our data and cross-link all of your extended classes back to ours. This way you don't have to document another projects code, you simply point over to their docs like it was part of yours.