Live Documenter Desktop

The desktop application enables a live view of your current project documentation and exporting your content to web, compiled help and other formats. Helping developers get up to speed on projects quicker.

Get Started

Use the Open fileā€¦ button to navigate to your solution, project or dll file and open it. You will be immediately shown the documentation.

Live Documenter toolbar

You can now use the left hand pane to navigate through the namespaces, classes and members and view the documentation for your selection on the right.

Have a look around and enjoy. If you need more details, the interface and available functionality are below.

Getting around the application

The toolbar provides a quick way to access the major functionality available in Live Documenter.

Live Documenter toolbar

The options from left to right are:

  • File open - this allows you to open a new project for viewing.

  • Save - Saving, allows you to store your current settings and configuration as a Live Documenter project file. These files can be used as a basis for exporting in the command line application.

  • Print - prints the currently viewed document.

  • Export - produce a static version of the documentation for the entire project you are viewing. Examples of export functionality can be found here.

  • Go back - navigate to the previously viewed page.

  • Go forward - navigate forward through your navigation history.

  • Add files to project - adds additional projects, solutions or libraries to your current documentation set.

  • Remove files from project - removes libraries from your current project. See here for more information about ldproj files.

View settings

At the bottom of the page of the document a number of settings are available that control how you view the documentation. These settings are saved in your user profile so only need to be changed once.

View options

From left to right these settings are:

  • Page view - view all content for this entry as a collection of single pages which can be navigated.

  • Multi coloumn view - View the current entry in multiple columns.

  • Single scrollable view - view the docuementation for the current entry as a single contigous page that can be scrolled.

  • Font size - change the size (decreease and increase) of the font used.

Live updating

One of the many features of the Live Documenter is that it continually displays a live up-to-date representation of your project documentation. Every time you perform a build of your software in Visual Studio (or otherwise modify the binaries) Live Documenter will automatically reload the documentation so your view is up to date.

This feature happens automatically and requires no configuration.

Overview

Starting up the desktop application will present you with the start screen. Here we can open projects, solutions or individual libraries. Click the open dialogue and select a project you are currently working on.

You will be presented with a screen that shows in the left hand panel the namespaces that are defined in your project and in the right hand panel the documentation. Expanding namespaces and selecting items on the left hand side is a simple way to navigate through a project to find documentation.

Live Documenter documentation screen

A more convenient way of finding information is to use the search bar at the top of the left hand panel. Typing here will present you with a list of all the types and members that match your criteria.

Searching in Live Documenter

Live Documenter is packaged with a number of pre-built export configurations. Selecting the export option will present you with a dialogue to export your documentation.

Documentation export

For now select the Web MSDN export, and note the location that it is being exported to. Be careful not to output to an existing directory as the contents are cleaned prior to exporting. Hit the go button.

In a small amount of time the success message will be shown and your documentation is complete. Navigate to the folder and select the index.htm file to browse the documentation you have just created.

More information