Re: Do people actually use markdown or should I abandon it and migrate to xdocs?

[Barrie Treloar]

Hervé thanks for spotting someone had problems that may be
un-addressed, I completely missed following that through.

-
To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
For additional commands, e-mail: users-h...@maven.apache.org

Re: Do people actually use markdown or should I abandon it and migrate to xdocs?

[Hervé BOUTEMY]

community is large: a lot of people use a lot of formats with maven-site-
plugin
and a lot of people have their own opinion about the format for the future :)

That's the first time I hear about 10 minutes to generate the hand-written 
markup (whatever the format is or the number of files): what can take time are 
the reports, but not markup
For example, 10 seconds is the time to render markup from the Maven's site
[INFO] Rendering 185 Doxia documents: 144 apt, 4 fml, 28 markdown, 9 xdoc

Can you please open a Jira issue, with example or at least log for me to 
understand where time is going?
(in maven-site-plugin 3.4, I added the previous output to more clearly 
distinguish reports from handwritten Doxia documents, see MSITE-714)


Then that's the first time I hear about maven-site-plugin's Markdown threading 
issues: is there any Jira issue about it, with example to reproduce?

notice that multi-module site plugin already stresses core regarding reports 
(with aggregate reports requiring modules): I don't think building the site in 
parallel is a great idea, or at least that it is really well tested
Perhaps you should aboid this one (you don't build the site on each code 
build, aren't you?)

Regards,

Hervé

Le jeudi 12 mars 2015 14:11:59 Kevin Burton a écrit :
> I really wanted to live in the future but I think Markdown support in Maven
> is really lacking.
> 
> 1. it’s super slow.  I have a moderate sized project (10 small files) and
> it takes like 10 minutes to generate my site.
> 
> 2.  It’s buggy.  If you have two projects and a multi-module build you
> can’t use threaded builds.
> 
> Now it looks as if my documentation generation has completely locked up.
> I’m not sure what change I made but 9/10 times I run it locks up in an
> infinite loop.
> 
> I imagine if no one else is actually using it then I should probably just
> use what the community is running.


-
To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
For additional commands, e-mail: users-h...@maven.apache.org

Re: Do people actually use markdown or should I abandon it and migrate to xdocs?

[Stephen Connolly]

asciidoc(tor) is the way of the future.

On 13 March 2015 at 00:44, Barrie Treloar  wrote:

> On 13 March 2015 at 11:05, Kevin Burton  wrote:
> > Thanks.  IF these are used in big projects like this I’ll probably just
> > migrate.
>
> Wasn't there some talk about using reStructuredText at some stage?
>
> I'm only just tinkering with that now on other projects so I have not
> investigated whether the Maven pipeline supports it.
>
> -
> To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
> For additional commands, e-mail: users-h...@maven.apache.org
>
>

Re: Do people actually use markdown or should I abandon it and migrate to xdocs?

[Barrie Treloar]

On 13 March 2015 at 11:05, Kevin Burton  wrote:
> Thanks.  IF these are used in big projects like this I’ll probably just
> migrate.

Wasn't there some talk about using reStructuredText at some stage?

I'm only just tinkering with that now on other projects so I have not
investigated whether the Maven pipeline supports it.

-
To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
For additional commands, e-mail: users-h...@maven.apache.org

Re: Do people actually use markdown or should I abandon it and migrate to xdocs?

[Kevin Burton]

Thanks.  IF these are used in big projects like this I’ll probably just
migrate.

It’s good to be pragmatic sometimes!

KEvin

On Thu, Mar 12, 2015 at 2:58 PM, Manfred Moser  wrote:

> I find markdown as a format just too restricted and painful to use. We had
> good success with using asciidoc for the Android Maven Plugin for site
> generation. It uses the very active asciidoctor project for rendering in
> the site.
>
> http://simpligility.github.io/android-maven-plugin/
>
>
> The Maven and Nexus books are also using asciidoc as a format btw.
>
> https://github.com/sonatype/maven-reference-en
> https://github.com/sonatype/nexus-book
> https://github.com/sonatype/maven-example-en
>
> Hope that helps.
>
> Manfred
>
> Kevin Burton wrote on 12.03.2015 14:11:
>
> > I really wanted to live in the future but I think Markdown support in
> Maven
> > is really lacking.
> >
> > 1. it’s super slow.  I have a moderate sized project (10 small files) and
> > it takes like 10 minutes to generate my site.
> >
> > 2.  It’s buggy.  If you have two projects and a multi-module build you
> > can’t use threaded builds.
> >
> > Now it looks as if my documentation generation has completely locked up.
> > I’m not sure what change I made but 9/10 times I run it locks up in an
> > infinite loop.
> >
> > I imagine if no one else is actually using it then I should probably just
> > use what the community is running.
> >
> > --
> >
> > Founder/CEO Spinn3r.com
> > Location: *San Francisco, CA*
> > blog: http://burtonator.wordpress.com
> > … or check out my Google+ profile
> > 
> > 
> >
>
> -
> To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
> For additional commands, e-mail: users-h...@maven.apache.org
>
>


-- 

Founder/CEO Spinn3r.com
Location: *San Francisco, CA*
blog: http://burtonator.wordpress.com
… or check out my Google+ profile

Re: Do people actually use markdown or should I abandon it and migrate to xdocs?

[Manfred Moser]

I find markdown as a format just too restricted and painful to use. We had good 
success with using asciidoc for the Android Maven Plugin for site generation. 
It uses the very active asciidoctor project for rendering in the site.

http://simpligility.github.io/android-maven-plugin/
 

The Maven and Nexus books are also using asciidoc as a format btw.

https://github.com/sonatype/maven-reference-en
https://github.com/sonatype/nexus-book
https://github.com/sonatype/maven-example-en

Hope that helps. 

Manfred

Kevin Burton wrote on 12.03.2015 14:11:

> I really wanted to live in the future but I think Markdown support in Maven
> is really lacking.
> 
> 1. it’s super slow.  I have a moderate sized project (10 small files) and
> it takes like 10 minutes to generate my site.
> 
> 2.  It’s buggy.  If you have two projects and a multi-module build you
> can’t use threaded builds.
> 
> Now it looks as if my documentation generation has completely locked up.
> I’m not sure what change I made but 9/10 times I run it locks up in an
> infinite loop.
> 
> I imagine if no one else is actually using it then I should probably just
> use what the community is running.
> 
> -- 
> 
> Founder/CEO Spinn3r.com
> Location: *San Francisco, CA*
> blog: http://burtonator.wordpress.com
> … or check out my Google+ profile
> 
> 
> 

-
To unsubscribe, e-mail: users-unsubscr...@maven.apache.org
For additional commands, e-mail: users-h...@maven.apache.org