Document! X Info Pages:

Javascript Documentation Made Easy

Document! X is a combination of an automated Javascript Documentation Tool and a full documentation authoring environment which can be used to create and maintain accurate, professional quality Javascript documentation for plain Javascript, jQuery Plugins and jQuery Widgets.

Document! X is not just an automated documentation build tool - it is also includes a fully featured documentation authoring environment allowing you to author supplementary content (descriptions and remarks for Types, Members, hyperlinks to related pages, example code, index kewords etc.) where required.

Document! X produces a professional quality documentation set leveraging your existing JsDoc or Xml format source comments - automatically - with the ability to author additional content outside of the source code.

Download a Free Trial Version

Why Use Document! X?

Fast, accurate, professional quality Javascript documentation;
Market leading authoring tools for creating supplementary content;
Document types, enumerations, interfaces, functions, fields, events, jQuery plugins, jQuery UI Widgets, asynchronous module definitions;
Customizable HTML based template driven output can be adapted to your requirements;
Generate documentation to HTML Help 1.x (CHM) and/or web ready pure HTML including a full Table of Contents, Index and Full Text Search.

Demonstration Movies

These short movies provide a great way to discover what can be achieved using Document! X.

Documenting a Javascript Library

This movie will demonstrate how Document! X can be used to create documentation for Javascript, both simple javascript function libraries as well as javascript object models and jQuery plugins and widgets. (13 mins)

View this Movie

Publishing to a web site, ftp server or network location

This movie demonstrates the new Publishing functionality introduced in 2015.1. Publishing makes it easy to publish output generated by Document! X or HelpStudio to a web server or network location. A range of publishing methods are supported; you can publish to an Azure web site, a web site running on IIS, a web site that supports uploading via ftp, or directly to a local network path. (11 mins)

View this Movie

Finding Undocumented Items

This movie provides a quick introduction to finding items in a project that still require documentation by using the Undocumented Items tool. (4 mins)

View this Movie

Introduction to Source Control

This video provides a demonstration on how to enable Source Control functionality, add a project to Source Control and access Source Control features in a Source Control enabled project. (6 mins)

View this Movie

Automatic optimization for Tablet and Mobile devices

This video demonstrates how the Responsive Output feature allows you to generate content that automatically adapts to the device type of the browser, providing an optimal experience for Mobile, Tablet and Desktop users from a single output. (5 mins)

View this Movie

Introduction to Localization features

This video will demonstrate how to use the localization features by enabling localization and creating both an English and Japanese output from the Document! X .NET sample project (9 mins).

View this Movie

Using Build Profiles to create multiple outputs

This short video provides a demonstration of how you can configure a project to create multiple outputs from a single source, with each output driven by a separate options defined in the Build Profile. (3 minutes)

View this Movie

More Movies

Content Authoring Options

You can choose to author content in JsDoc or Xml Format source comments, and/or using the Document! X Content File editor. This flexibility allows you to include basic documentation in the source code and use the rich Document! X Content File editor to author extended content (e.g. examples, tutorials, more detailed descriptions etc.).

Content File Editor

In combination with, or as an alternative to authoring content in JSDoc or Xml format source code comments, create and maintain documentation content using the Document! X Content File Editor.

Leverage JsDoc format source comments

Document! X will automatically use any JsDoc format source code comments and use them in the generated output.

Leverage Xml format source comments

Document! X will automatically use any Microsoft xml format source code comments and use them in the generated output.

Example Code Designer

A specific designer is included in the Content File Editor to make creating examples quick and easy. Paste example code or use existing code files (or named regions within them) as your source.

Automatically Generated Syntax

Document! X will automatically generate a Syntax and Usage section in member pages. Regular Javascript syntax, or a specific syntax for jQuery libraries and widgets is output as appropriate.

Single Source Build and Publish

Your documentation projects can be built to Browser Help or CHM (Html Help 1.x). The specific requirements for the different output formats are handled for your automatically and you can build all output formats from a single project. Automatic publishing makes it quick and simple to deploy the generated output to your web site, ftp server or network location.

Browser Help

Browser Help output is viewable directly in the web browser, so is the ideal format for publishing documentation on a web site or intranet site. The browser help output includes a Table of Contents, Index and Full Text Search.

Tablet and Mobile Support

The automatically generated responsive support allows you to generate a single output that automatically adapts to the device profile; delivering an optimal browsing experience for Desktop, Tablet and Mobile from a single output. Tablet and Mobile devices benefit from buttonized links, a button based fly out Table of Contents and other automatic features that dramatically improve the end user experience.

Html Help 1.x (CHM)

Html Help 1.x (CHM) is the Microsoft Windows compiled help file format. When building to CHM, the output is a single file that can be deployed to, and viewed on, any machine with Windows installed. The CHM viewer includes a Table of Contents, Index and Full Text Search.

Publish to network path, ftp, Azure and IIS

Your built documentation can be automatically published to a range of locations; a network path, ftp server, Azure web site or IIS (Internet Information Services) Server. Publishing recongizes which files have changed in the last build, so publishing is quick and minimizes network traffic.

Community Features

The generated output can be automatically integrated with a range of Community Providers (Facebook, Disqus, Livefyre or SolidOpinion) allowing you to include rich community features in your help systems.

Sample Outputs

These sample outputs illustrate how much can be generated by Document! X right out of the box. All of the Document! X Templates are fully customizable and can be easily adapted or extended to meet your specific requirements.

Library Overview Page

Overview of the Javascript Library, listing the documented Namespaces, jQuery Plugins and jQuery Widgets.

jQuery Plugin Page

Page generated for a jQuery plugin, documenting the syntax, options and methods.

Type Members Page

Details the members (methods, properties, fields, events) of a documented type.

Method Page

Page generated for a method, documenting the syntax and parameters.

Field / Option Page

Page generated for a field / option, documenting the syntax.

Live Samples

Document Everything

Document! X doesn't just document Javascript, it supports a wide variety of solution elements. One consistent and comprehensive toolset for all of your technical documentation requirements.