DocumentJS for Designers
lsg-adding-designers
If you're working on a project that is already using DocumentJS, it is being used to generate JavaScript API docs. Since it's already being used, with only a little configuration you should be able to:
To see an example of this in action, check out the example Live Style Guide.
What DocumentJS Does
Skip this section if you're comfortable with magic and don't care how DocumentJS works.
DocumentJS is a static site generator. This means it scans specially formatted input files and creates a website that remains unchanged until the generator runs again. Whereas in a content management system changes happen somewhat automatically, a static site generator usually needs to be run manually and then the generated files must be uploaded.
While this may seem more complicated than a CMS, static site generation works especially well for a Live Style Guide. Since your stylesheets are also the source files for your style guide, changes to your stylesheets are also changes to your Live Style Guide.
To build your Live Style Guide, DocumentJS does the following:
@page
,@group
, and@parent
to determine site layout@stylesheet
,@styles
, and@demo
to create the individual parts of your style guidehtml
filesNext Page