171,244
Customers have installed this add-on in at least 1,244 active instances.

ReadMe Parser

by Pirate Ninja Unicorn for Stash 3.0.1 - 3.11.2 and more versions
Versions available for Stash 1.1.0 - 1.1.2
Stash 1.3.0 - 2.12.6
Unsupported
This add-on isn't formally supported, but you can ask a question via Atlassian Answers.

Ask a question

    Display the rendered content of your project's README files just as you're used to on GitHub or Bitbucket

    Renders a wide variety of markup formats

    Renders ALL readme files in your repository

    Relative links and image paths

    The Readme Parser currently supports rendering of Markdown, Textile, MediaWiki, TWiki and reStructuredText (RST) markup.

    You can use relative links and image paths to files in your repository as you are used to.

    All files in your repository with matching file endings of one of the supported markup types will be listed in Overview tab and will be rendered.

    Available in Overview Tab of your repository, rendering readme files of your default branch or selected branch.

    You can use relative links and image paths to files in your repository as you are used to.

    User reviews

    (17)
    Sign in to write a review »
    by andrea cadeddu on 2014-05-21
    It does not renders images in the view under the files panel. Which is the default view. It also does not work with branches different than master.
    0 out of 1 found this review helpful
    Was this review helpful?YesNo

    Vendor response

    Hi Andrea,

    Are you sure, you commented on the right plugin? Please note, that this add-on "ReadMe Parser" is not responsible for a readme preview under the file list. Please have a look at our screenshots for comparison.

    Our plugin does render images and works properly with branches. We would be happy if you try our add-on.

    Kind regards

    Theresa

    by Philip Bergen on 2014-05-14
    Does this put anchor tags so I can deep link to a specific heading?
    Was this review helpful?YesNo

    Vendor response

    Hi Philip,

    unfortunately not yet. But we would be happy to hear your ideas and suggestions in our issue tracker to follow these features up and let you know about our progress.

    Best regards

    Theresa

    by Quinn Hoyer on 2014-04-29
    Does not implement all of GitHubs markdown features, like code...
    2 out of 3 found this review helpful
    Was this review helpful?YesNo

    Vendor response

    Hi Quinn,

    actually it does support the GitHub style "Fenced code blocks".

    We would be happy to hear any other suggestions in our issue tracker.

    Best regards

    Theresa

    by Marko Bjelac on 2013-12-06
    Images embedded with Markdown's image syntax ![alt](imageUrl) are rendered distorted (a bit larger). Even pixel-clear gifs are blurry. The original image clarity can be verified by viewing the image directly (right-click, View Image). Using Atlassian Stash v2.8.4
    Was this review helpful?YesNo

    Vendor response

    Hi Marko,

    thanks for your suggestions. Please help us to improve the plugin and report any issues at our issue tracker.

    Best regards

    Theresa

     

    Edit: This was a comment in regard to Atlassians readme parser, which seemed to scale images.

    by Mark Andrachek on 2013-08-08
    Using stash 2.6.3, with this enabled, screws up navigation. Additionally, .md files do not apparently get parsed properly (for example, attempting to embed the build status image provided by jenkins - just shows the raw markdown)
    Was this review helpful?YesNo

    Vendor response

    Hi Mark,

    thank you for your input.

    If you experience any problems using this add-on, please feel free to report an issue at our issue tracker.

    Best regards

    Theresa

    More details

    The Stash Readme Parser Plugin extends your Atlassian Stash instance to display the rendered content of your project's README file just as you're used to do on GitHub or Bitbucket.The plugin supports multiple formats like markdown, textile, mediawiki, twiki and rst markup for rendering.

    You can use relative links and image paths to files in your repository as you are used to.

    Free add-on FAQ

    Good news! This add-on is free.

    Support

    ReadMe Parser isn't formally supported.

    Release notes

    Version 1.4.3 Stash 3.0.1 - 3.11.2 Released 2015-04-26

    Summary

    Security fix

    Installation

    1. Log into your Stash instance as an admin.
    2. Click the admin dropdown and choose Add-ons. The Manage add-ons screen loads.
    3. Click Find new add-ons from the left-hand side of the page.
    4. Locate ReadMe Parser via search. Results include add-on versions compatible with your Stash instance.
    5. Click Install to download and install your add-on.
    6. You're all set! Click Close in the Installed and ready to go dialog.

    To find older ReadMe Parser versions compatible with your instance, you can look through our version history page.

    Similar add-ons