Stack Overflow
Stack Overflow

Questions tagged [doxia]

Maven Doxia is a content generation framework for generating static and dynamic content.

21 questions
9
votes
5 answers

Format code in Doxia Apt Format

I am currently starting to write a documentation for one of our projects. For reasons of simplicity we chose to use the Almost Plain Text (APT) Format, see more info here: http://maven.apache.org/doxia/references/apt-format.html APT is great…
evgeni
  • 1,675
  • 3
  • 22
  • 29
4
votes
1 answer

Using other markup languages with maven doxia books

I know it is possible to write my maven site in markdown, using e.g. http://code.google.com/p/doxia-module-markdown/wiki/Usage Is it also possible to create books written in markdown or rest? I couldn't make this work using book-descriptors as…
Daniel Seidewitz
  • 720
  • 8
  • 23
4
votes
1 answer

Placeholder substitution in a Maven APT page

I am working on Maven site documentation for some related projects, and I want to create a hyperlink from one site's documentation to another sites documentation. The wrinkle is that the URL for the link target depends on a Maven property. I tried…
Stephen C
  • 698,415
  • 94
  • 811
  • 1,216
3
votes
0 answers

Verbatim Text in Doxia APT Table

Using Doxia APT format, I would like to include verbatim text or a snippet within a table. *------------+----------------------------+ || col1 || col2 | *------------+----------------------------+ | some text | VERBATIM…
shelley
  • 7,206
  • 4
  • 36
  • 63
3
votes
2 answers

Getting doxia-module-markdown to rewrite *.md links

My goal is to generate site documentation that is also browsable from within github, so I've written a bunch of markdown pages. I'm using maven-site-plugin with doxia-module-markdown to generate project documentation. The problem I'm running into is…
Mike Samuel
  • 118,113
  • 30
  • 216
  • 245
3
votes
1 answer

How to make Eclipse work with the snippet macro in maven doxia files?

I want to use the snippet macro in my maven site documentation in order to allow for testing of my examples code snippets with JUnit. But I don't want Eclipse to show the red "there is a build error" marker for all of my projects (which it does…
thobe
  • 1,573
  • 1
  • 11
  • 9
3
votes
1 answer

doxia markdown issue with ampersand in links

when I create a maven site with (doxia-module-markdown)[http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-markdown] and the .md file has links with ampersands it results in an errormessage. example.md: # Getting Started ## Now 1. goto…
Daniel
  • 61
  • 9
3
votes
1 answer

Documentation with Doxia + Ant

I would like to use Doxia to generate some documentation but invoke it with Ant (and no, Maven is not an option). I was looking for some pointers but nothing popped up after a few Google search. Did anyone already used Doxia in an Ant environment…
Vladimir
  • 6,853
  • 2
  • 26
  • 25
2
votes
2 answers

How to retrieve the name of the file being rendered by "mvn site" in site.vm?

I'm creating a Maven Skin (see https://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/). My site.vm needs to highlight links in a nav bar if the link is the current file being rendered. I therefore need to know the name of the HTML file…
Bertrand Martin
  • 533
  • 1
  • 3
  • 16
2
votes
1 answer

maven-linkcheck-plugin warning during link checking: cookie rejected, illegal domain attribute

I am generating a project site with mvn site Linkcheck is activated as a reporting plugin (...) org.apache.maven.plugins …
Amedee Van Gasse
  • 7,280
  • 5
  • 55
  • 101
2
votes
1 answer

How to add local HTML anchors for sections with Doxia?

In a Maven site doc I use code like this for sections:
Foo
How do I tell Doxia I want the section name/title to be an HTML local anchor?…
Marcel Stör
  • 22,695
  • 19
  • 92
  • 198
2
votes
1 answer

Display a dollar sign inside a code span using maven site and markdown

I would like to display a dollar sign inside a code span generated with maven-site-plugin and markdown (doxia-module-markdown). Out of a code span, I used the numerical code $ and it fixed the issue. But inside a code span (4 spaces), the…
tduchateau
  • 4,351
  • 2
  • 29
  • 40
1
vote
0 answers

How to encode special characters into link in xdoc

We have xdoc documentation for our Java library. It links to Javadoc and shows code examples on how to use the library. Some of our links to the Javadoc use special characters like parenthesis for methods. Javadoc is generated from standard javadoc…
rveach
  • 2,081
  • 15
  • 25
1
vote
1 answer

Maven site generation using advanced Markdown?

We are using Markdown in our Maven generated site. Works like a charm. AFAIK the plugin uses Flexmark under the hood, which supports the Admonition extensions. We would like to use them too, the infoboxes are quite helpful for documentation. Our…
stwissel
  • 20,110
  • 6
  • 54
  • 101
1
vote
1 answer

How can I get parens in a URL using the Doxia APT format?

I am using the APT format to create documentation on a maven project. I am trying to link to a JavaDoc method description, which URL contains a parentheses. For example, the url…
Jeremy
  • 1,015
  • 4
  • 11
  • 20
1
2