chrisparnin / automark

auto-generate blog post from coding history
20 stars 1 forks source link

automark

automark enables reviewing, sharing, and summarizing programming tasks by automatically generating markdown from your coding history.

The auto-generated markdown or rendered html can help you:

  1. Hand-off tasks to other teammates,
  2. Recover from an interruption, or
  3. Document how to perform a similar task in the future.

It is available as a Visual Studio extension in the Visual Studio gallery.

Motivation

Developers commonly blog about how-to tasks and development experiences in programming. But not everyone blogs, and the ones that do often spend several hours recalling, formatting, and crafting a blog post. The goal of automark is to

  1. reduce the friction associated with blogging,
  2. make it more habitual, and
  3. allow developers to focus on the narrative of a blog post.

Example output created with automark:

DiffHighlight

See the full example of a blog post created with automark.

Features

Automark is designed to support episodic review, a cognitive process for walking through and reasoning about recent code changes, mistakes, and events.

To support this, automark can

Using automark

To use automark, first ensure that autogit has been installed first.

Menu

To generate a markdown representation of the recent coding task, select Tools -> automark -> Generate Markdown. This will generate a markdown file stored in $SolutionFolder\.HistoryData\md\Timestamp.md and then open it in an markdown editor. For windows, I recommend using Markdown Pro. From here, the markdown can be annotated and further later generated as a html.

Markdown

To generate a rendered html representation, including diff highlighting, select Tools -> automark -> Generate Html.

Html

Installing automark

Future Features