The Artima Developer Community
Sponsored Link

Java Buzz Forum
Hack of the day: Stash Markdown Bookmarklet

0 replies on 1 page.

Welcome Guest
  Sign In

Go back to the topic listing  Back to Topic List Click to reply to this topic  Reply to this Topic Click to search messages in this forum  Search Forum Click for a threaded view of the topic  Threaded View   
Previous Topic   Next Topic
Flat View: This topic has 0 replies on 1 page
Mathias Bogaert

Posts: 328
Nickname: pathos
Registered: Aug, 2003

Mathias Bogaert is a senior software architect at Intrasoft mainly doing projects for the EC.
Hack of the day: Stash Markdown Bookmarklet Posted: Feb 19, 2013 3:35 AM
Reply to this message Reply

This post originated from an RSS feed registered with Java Buzz by Mathias Bogaert.
Original Post: Hack of the day: Stash Markdown Bookmarklet
Feed Title: Scuttlebutt
Feed URL: http://feeds.feedburner.com/AtlassianDeveloperBlog
Feed Description: tech gossip by mathias
Latest Java Buzz Posts
Latest Java Buzz Posts by Mathias Bogaert
Latest Posts From Scuttlebutt

Advertisement
I’ve been writing a lot of documentation lately. On the Stash team we keep the bulk of our developer documentation in the Stash git repository, right alongside our production code. This approach means that as we introduce new plugin points, developers can review and critique the documentation for those plugin points in the same pull request as the code change. This has proved a convenient feedback mechanism and has made keeping our developer documentation up-to-date much easier. We use markdown syntax for our documentation, which gets transformed into HTML as part of our release process and uploaded to developer.atlassian.com as a static site. Markdown is specifically designed to be easy-to-read even in its unrendered text format, but when reviewing doc changes we typically build the docs to make sure the rendered version looks nice too. Building the docs currently means leaving the browser and running a special maven command in the Stash project, which doesn’t take long but any context switch (particularly one involving maven) is a bit of a productivity sink. Fortunately, Stash supports markdown natively for rendering comments and pull request descriptions. It also has a nifty REST end-point used by the Stash UI for rendering previews of comments. This made it trivial to whip up a little bookmarklet that downloads the raw content of the file you’re viewing, render it using the comment preview REST resource and replace the source pane with the rendered content, turning this: into this: It also works on any Stash source view. With JQuery already on the page to do the DOM manipulation and handle the ajax requests, and a REST end-point to do all the heavy lifting, there’s really not much to it: javascript:(function(){     /* grab the URL of the source file being viewed from the DOM */     var sourceLink = $(".source-view-link:visible").attr("href"); /* pull request view */         if (!sourceLink) {         sourceLink = $(".raw-view-link:visible").attr("href"); /* source view */         if (!sourceLink) {             alert("No source here.");             return;         }     }       /* we want the raw, undecorated content of the file */     var rawLink = sourceLink + "&raw";     var errorHandler = function(xhr, status, thrown) {         /* happy path fo' lyfe */         alert("error: " + status + " " + thrown);     };     /* function for rendering markdown content via the markup renderer resource */     var render = function(markdown) {         $.ajax(AJS.contextPath() + "/rest/api/1.0/markup/preview", {             type: "POST",             success: function(data) {                 /* inject the rendered content into the view */                 $(".source-container:visible").html(data.html)             },             error: errorHandler,             [...]

Read: Hack of the day: Stash Markdown Bookmarklet

Topic: JavaFX Coming Soon to an Android or iOS Device Near You? Previous Topic   Next Topic Topic: Increased compile-time safety with phantom types


Sponsored Links



Google
  Web Artima.com   

Copyright © 1996-2014 Artima, Inc. All Rights Reserved. - Privacy Policy - Terms of Use - Advertise with Us