public class MarkdownTool
extends java.lang.Object
Markdown toolbox
Constructor and Description |
---|
MarkdownTool() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
code(java.lang.String code) |
static java.lang.String |
code(java.lang.String code,
java.lang.String language) |
static java.lang.String |
docForModule(Grant g,
java.lang.String name,
boolean header,
boolean services,
int titleLevel)
Documentation for specified module
|
static java.lang.String |
docForObject(Grant g,
java.lang.String name,
boolean header,
boolean services,
int titleLevel)
Documentation for specified object
|
static java.lang.String |
docHeader(Grant g)
Documentation header
|
static java.lang.String |
image(java.lang.String url,
java.lang.String alt) |
static java.lang.String |
link(java.lang.String url,
java.lang.String label) |
static void |
main(java.lang.String[] args) |
static java.lang.String |
prepare(java.lang.String md) |
static java.lang.String |
quote(java.lang.String text) |
static java.lang.String |
title(java.lang.String title,
int level) |
static java.lang.String |
title1(java.lang.String title) |
static java.lang.String |
title2(java.lang.String title) |
static java.lang.String |
title3(java.lang.String title) |
static java.lang.String |
title4(java.lang.String title) |
static java.lang.String |
title5(java.lang.String title) |
static java.lang.String |
toHTML(java.io.File file)
Convert a markdown file to HTML (parsing done on server side)
Warning: the parsed used for conversion does not yet convert Markdown tables |
static void |
toHTML(java.io.InputStream in,
java.io.OutputStream out)
Convert a markdown input stream to HTML and write it to output stream (parsing done on server side)
Warning: the parsed used for conversion does not yet convert Markdown tables |
static java.lang.String |
toHTML(java.lang.String md)
Convert a markdown string to HTML (parsing done on server side)
Warning: the parsed used for conversion does not yet convert Markdown tables |
static java.lang.String |
toHTML(java.lang.String title,
java.io.File file)
Deprecated.
User toHTMLPage
|
static java.lang.String |
toHTML(java.lang.String title,
java.io.File file,
java.lang.String encoding)
Deprecated.
User toHTMLPage
|
static java.lang.String |
toHTML(java.lang.String title,
java.lang.String md)
Deprecated.
User toHTMLPage
|
static java.lang.String |
toHTMLPage(java.lang.String title,
java.io.File file)
Convert a markdown file (in default encoding) to HTML page (parsing done on client side)
|
static java.lang.String |
toHTMLPage(java.lang.String title,
java.io.File file,
java.lang.String encoding)
Convert a markdown file (in specified encoding) to HTML page (parsing done on client side)
|
static java.lang.String |
toHTMLPage(java.lang.String title,
java.lang.String md)
Convert a markdown string to an HTML page (parsing done on client side)
|
@Deprecated public static java.lang.String toHTML(java.lang.String title, java.lang.String md)
public static java.lang.String toHTMLPage(java.lang.String title, java.lang.String md)
title
- Titlemd
- Markdown string@Deprecated public static java.lang.String toHTML(java.lang.String title, java.io.File file, java.lang.String encoding) throws java.lang.Exception
java.lang.Exception
public static java.lang.String toHTMLPage(java.lang.String title, java.io.File file, java.lang.String encoding) throws java.lang.Exception
title
- Titlefile
- Markdown fileencoding
- Encodingjava.lang.Exception
@Deprecated public static java.lang.String toHTML(java.lang.String title, java.io.File file) throws java.lang.Exception
java.lang.Exception
public static java.lang.String toHTMLPage(java.lang.String title, java.io.File file) throws java.lang.Exception
title
- Titlefile
- Markdown filejava.lang.Exception
public static java.lang.String prepare(java.lang.String md)
public static java.lang.String title(java.lang.String title, int level)
public static java.lang.String title1(java.lang.String title)
public static java.lang.String title2(java.lang.String title)
public static java.lang.String title3(java.lang.String title)
public static java.lang.String title4(java.lang.String title)
public static java.lang.String title5(java.lang.String title)
public static java.lang.String code(java.lang.String code)
public static java.lang.String code(java.lang.String code, java.lang.String language)
public static java.lang.String quote(java.lang.String text)
public static java.lang.String link(java.lang.String url, java.lang.String label)
public static java.lang.String image(java.lang.String url, java.lang.String alt)
public static java.lang.String toHTML(java.lang.String md)
md
- Markdown stringpublic static java.lang.String toHTML(java.io.File file) throws java.lang.Exception
file
- Markdown filejava.lang.Exception
public static void toHTML(java.io.InputStream in, java.io.OutputStream out) throws java.lang.Exception
in
- Markdown input streamout
- Markdown output streamjava.lang.Exception
public static java.lang.String docHeader(Grant g)
g
- Grantpublic static java.lang.String docForModule(Grant g, java.lang.String name, boolean header, boolean services, int titleLevel) throws java.lang.Exception
g
- Grantname
- Module nameheader
- Include header ?services
- Service output ?titleLevel
- Title leveljava.lang.Exception
public static java.lang.String docForObject(Grant g, java.lang.String name, boolean header, boolean services, int titleLevel) throws java.lang.Exception
g
- Grantname
- Object nameheader
- Include header ?services
- Service output ?titleLevel
- Title leveljava.lang.Exception
public static void main(java.lang.String[] args)
Copyright (c)2006-2014 Simplicite Software. All Rights Reserved.