Bitbucket is a code hosting site with unlimited public and private repositories. We're also free for small teams!

Close

Introduction

Markdown-doclet is a tool to use Markdown text in javadoc. It uses pegdown as dependency.
Pegdown is a pure Java library for clean and lightweight Markdown processing. It's implementation is based on a parboiled PEG parser and is therefore rather easy to understand and extend.

Installation

Download the JAR for latest version from the download page.
Additionally markdown-markdown requires JARs on the classpath:

Using markdown-doclet

TODO: add some examples

  • text - Markdown text (only for 'render' tag).
  • abbreviations - support for abbreviations in the way of PHP Markdown Extra.
  • autolinks - enables plain (undelimited) autolinks the way Github-flavoured-Markdown implements them.
  • hardwraps - enables alternative handling of newlines, see Github-flavoured-Markdown.
  • quotes - beautifys single quotes, double quotes and double angle quotes (« and »).
  • smarts - beautifys apostrophes, ellipsises ("..." and ". . .") and dashes ("--" and "---").
  • smartypants - convenience extension enabling both, --smarts and --quotes, at once.
  • tables - enables support for tables similar to MultiMarkdown (which is in turn like the PHP Markdown Extra tables, but with colspan support).
  • noBlocks - suppresses HTML blocks.
  • noInline - suppresses inline HTML tags.
  • noHypertext - suppresses HTML blocks as well as inline HTML tags.
  • all - enable all available extensions.
  • none - the default, standard markup mode without any extensions.

Recent activity

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.