You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@spark.apache.org by Stephen Boesch <ja...@gmail.com> on 2014/08/18 18:00:17 UTC

Markdown viewer for the docs

Which viewer is capable of seeing all of the content in the spark docs
-including the (apparent) extensions?

An example page:
https://github.com/apache/spark/blob/master/docs/mllib-linear-methods.md


Local MD viewers/editors that I have  tried include:   mdcharm,  retext and
haroopad: one of these handle the TOC,  the math symbols, or proper
formatting of the scala code

 Even directly opening the md file from  github.com with the browser those
same issues appear: no TOC, math, or proper code formatting.   I am tried
both FF and chrome (on ubuntu 12.0.4)


Any tips from  the creators/maintainers of these pages  Thanks!

Re: Markdown viewer for the docs

Posted by Kan Zhang <kz...@apache.org>.
If you are willing to compile it, "The markdown code can be compiled to
HTML using the [Jekyll tool](http://jekyllrb.com)." More in docs/README.md.


On Mon, Aug 18, 2014 at 9:00 AM, Stephen Boesch <ja...@gmail.com> wrote:

> Which viewer is capable of seeing all of the content in the spark docs
> -including the (apparent) extensions?
>
> An example page:
> https://github.com/apache/spark/blob/master/docs/mllib-linear-methods.md
>
>
> Local MD viewers/editors that I have  tried include:   mdcharm,  retext and
> haroopad: one of these handle the TOC,  the math symbols, or proper
> formatting of the scala code
>
>  Even directly opening the md file from  github.com with the browser those
> same issues appear: no TOC, math, or proper code formatting.   I am tried
> both FF and chrome (on ubuntu 12.0.4)
>
>
> Any tips from  the creators/maintainers of these pages  Thanks!
>