Quantcast

PolyMath documentation: github pages

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

PolyMath documentation: github pages

Alexey Cherkaev
Hi all,

Since PolyMath has a page on github (https://github.com/PolyMathOrg/PolyMath), should we make the Jekyll-based github-pages site to put documentation and tutorials? (https://jekyllrb.com/docs/github-pages/)

Advantage of using Jekyll-based site is the ability to combine LaTeX math formulas (with MathJax) and code snippets.

As a toy-project, I've created this site http://mobius-eng.github.io/ . It uses Tufte style (something like Feinman was using for his Lectures on Physics), but unfortunately, it uses extra plugins that github does not support, so site is generated manually on my computer and loaded to github (instead of being generated directly on github). The "source" code of the raw site can be found in "writing" branch https://github.com/mobius-eng/mobius-eng.github.io/tree/writing. If simpler style is used, the work on the site will be much more straight-forward.

PS. I know Pharo offers Pier and Pillar for structured documents writing. I am not familiar with them though, they might offer more "native" alternative to Jekyll-based websites.

Cheers,
Alexey

--
You received this message because you are subscribed to the Google Groups "SciSmalltalk" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: PolyMath documentation: github pages

SergeStinckwich
On Thu, Apr 28, 2016 at 7:44 PM, Alexey Cherkaev
<[hidden email]> wrote:
> Hi all,
>
> Since PolyMath has a page on github
> (https://github.com/PolyMathOrg/PolyMath), should we make the Jekyll-based
> github-pages site to put documentation and tutorials?
> (https://jekyllrb.com/docs/github-pages/)
>
> Advantage of using Jekyll-based site is the ability to combine LaTeX math
> formulas (with MathJax) and code snippets.

For documentation, I would like to create a repository and put
everything in Pillar if possible.

> As a toy-project, I've created this site http://mobius-eng.github.io/ . It
> uses Tufte style (something like Feinman was using for his Lectures on
> Physics), but unfortunately, it uses extra plugins that github does not
> support, so site is generated manually on my computer and loaded to github
> (instead of being generated directly on github). The "source" code of the
> raw site can be found in "writing" branch
> https://github.com/mobius-eng/mobius-eng.github.io/tree/writing. If simpler
> style is used, the work on the site will be much more straight-forward.

This is nice for a blog I think in order to attract people.

Regards,
--
Serge Stinckwich
UCBN & UMI UMMISCO 209 (IRD/UPMC)
Every DSL ends up being Smalltalk
http://www.doesnotunderstand.org/

--
You received this message because you are subscribed to the Google Groups "SciSmalltalk" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: PolyMath documentation: github pages

Alexey Cherkaev
On Thursday, April 28, 2016 at 2:52:38 PM UTC+2, Serge Stinckwich wrote:
On Thu, Apr 28, 2016 at 7:44 PM, Alexey Cherkaev
<<a href="javascript:" target="_blank" gdf-obfuscated-mailto="KUkggIjfMAAJ" rel="nofollow" onmousedown="this.href=&#39;javascript:&#39;;return true;" onclick="this.href=&#39;javascript:&#39;;return true;">alexey....@...> wrote:
> Hi all,
>
> Since PolyMath has a page on github
> (<a href="https://github.com/PolyMathOrg/PolyMath" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FPolyMathOrg%2FPolyMath\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHYqtugq3w7khm0Ohn_Kzo7BG7sZQ&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fgithub.com%2FPolyMathOrg%2FPolyMath\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNHYqtugq3w7khm0Ohn_Kzo7BG7sZQ&#39;;return true;">https://github.com/PolyMathOrg/PolyMath), should we make the Jekyll-based
> github-pages site to put documentation and tutorials?
> (<a href="https://jekyllrb.com/docs/github-pages/" target="_blank" rel="nofollow" onmousedown="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fjekyllrb.com%2Fdocs%2Fgithub-pages%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNE9wgrrNTiPK-2Q3-54mlGpgDx34g&#39;;return true;" onclick="this.href=&#39;https://www.google.com/url?q\x3dhttps%3A%2F%2Fjekyllrb.com%2Fdocs%2Fgithub-pages%2F\x26sa\x3dD\x26sntz\x3d1\x26usg\x3dAFQjCNE9wgrrNTiPK-2Q3-54mlGpgDx34g&#39;;return true;">https://jekyllrb.com/docs/github-pages/)
>
> Advantage of using Jekyll-based site is the ability to combine LaTeX math
> formulas (with MathJax) and code snippets.

For documentation, I would like to create a repository and put
everything in Pillar if possible.

I was looking at Pillar. Generally, it looks good. I see there is an issue open https://github.com/pillar-markup/pillar/issues/18 to add direct LaTeX support. It seems at the moment it doesn't support neither PNG/MathJax/MathML formulas in HTML export. The only support for math formulas in HTML export I could find is http://www.squeaksource.com/PRMath/ for Pier.

Cheers,
Alexey

--
You received this message because you are subscribed to the Google Groups "SciSmalltalk" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Loading...