Web service API

How to use PageSeeder's Web service API

preview markdown

/groups/{group}/markdown [POST]

com.pageseeder.comment.PreviewMarkdown

Description

Returns an XHTML preview of the supplied markdown text.

The output has the following format:

 <html>
   <section>
     <h2>This is a heading<h2>
     <p>With some <strong>important</strong> text.</p>
   </section>
 </html>

Parameters

Name Description Required Type Default value
text the markdown text yes string

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

The output has the following format:


 <html>
   <section>
     <h2>This is a heading<h2>
     <p>With some <strong>important</strong> text.</p>
   </section>
 </html>

Error Handling

No specific errors expected for this generator.

Created on , last edited on