You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Jason van Zyl <ja...@takari.io> on 2014/07/01 01:36:26 UTC
Using Markdown
I starting converting some site docs to Markdown and it's relatively straight forward. I used the Doxia converter to produce XHTML and then used Pandoc to convert that to Markdown. Works better than I expected. If anyone else wants to convert some documents here's what I used:
java -jar apache-doxia-1.3-SNAPSHOT-jar-with-dependencies.jar -in ${whatever}.apt -from apt -out . -to xhtml
pandoc -f html -t markdown --atx-headers ${whatever}.apt.xhtml > ${whatever}.md
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
http://twitter.com/jvanzyl
http://twitter.com/takari_io
---------------------------------------------------------
Re: Using Markdown
Posted by Jason van Zyl <ja...@takari.io>.
So my little experiment today was to convert some documents in the site to Markdown and see what tools were available for editing.
So I pushed a clone of the site to Github:
https://github.com/jvanzyl/maven-site/blob/master/content/markdown/what-is-maven.md
Even just viewing that is nice for people as it's more like a Wiki. But it gets better. Then I wired up
http://dillinger.io
to that repository and I immediately got instant viewing on the right while I'm editing on the left which is just awesome.
I believe this would enable the entire community to help edit the website as you fork a repo, pop open dillinger.io (or stackedit.io) and easily make edits and submit a PR.
It's just awesome.
On Jun 30, 2014, at 7:36 PM, Jason van Zyl <ja...@takari.io> wrote:
> I starting converting some site docs to Markdown and it's relatively straight forward. I used the Doxia converter to produce XHTML and then used Pandoc to convert that to Markdown. Works better than I expected. If anyone else wants to convert some documents here's what I used:
>
> java -jar apache-doxia-1.3-SNAPSHOT-jar-with-dependencies.jar -in ${whatever}.apt -from apt -out . -to xhtml
> pandoc -f html -t markdown --atx-headers ${whatever}.apt.xhtml > ${whatever}.md
>
> Thanks,
>
> Jason
>
> ----------------------------------------------------------
> Jason van Zyl
> Founder, Apache Maven
> http://twitter.com/jvanzyl
> http://twitter.com/takari_io
> ---------------------------------------------------------
>
>
>
>
>
>
>
>
>
>
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
http://twitter.com/jvanzyl
http://twitter.com/takari_io
---------------------------------------------------------
First, the taking in of scattered particulars under one Idea,
so that everyone understands what is being talked about ... Second,
the separation of the Idea into parts, by dividing it at the joints,
as nature directs, not breaking any limb in half as a bad carver might.
-- Plato, Phaedrus (Notes on the Synthesis of Form by C. Alexander)