The mathblog package

[Tags:bsd3, program]

This package provides a program for creating and managing a statically-generated, VCS-friendly, mathematically-inclined weblog. If you're interested in managing a blog with few moving parts and support for embedded LaTeX math, embedded function plotting, and the UNIX editor of your choice, then this is the blogging platform for you! For detailed information and a full feature list, please see the manual PDF in the doc directory.


[Skip to Readme]

Properties

Versions 0.1, 0.2, 0.3, 0.4, 0.5, 0.6
Change log CHANGELOG.md
Dependencies base (>=3 && <5), bytestring, ConfigFile (>=1.1), containers (>=0.3), data-default, deepseq (>=1.2), directory (>=1.0), either (>=3.4), filepath (>=1.1), fsnotify (>=0.0.6), HStringTemplate (>=0.6), HTTP, http-server (>=1.0.2), HUnit, JuicyPixels (>=3.1), mtl (>=2.0), network, old-locale (>=1.0), pandoc (>=1.12), pandoc-types (>=1.12), process (>=1.0), SHA (>=1.4), system-filepath, temporary (>=1.1.2), test-framework, test-framework-hunit, time (>=1.1), unix (>=2.3), url [details]
License BSD3
Author Jonathan Daugherty <cygnus@foobox.com>
Maintainer Jonathan Daugherty <cygnus@foobox.com>
Stability Unknown
Category Web
Home page http://jtdaugherty.github.io/mathblog/
Source repository head: git clone git://github.com/jtdaugherty/mathblog.git
Uploaded Sat Oct 3 22:14:47 UTC 2015 by JonathanDaugherty
Distributions NixOS:0.6
Downloads 953 total (27 in the last 30 days)
Votes
0 []
Status Docs not available [build log]
All reported builds failed as of 2015-11-13 [all 3 reports]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for mathblog

Readme for mathblog-0.6

mathblog

mathblog is a Haskell program targeted at people who want to write statically-generated, mathematically-themed weblogs. It supports:

  • Extended Markdown input syntax as supported by the Pandoc library

  • Inline and block-level TeX math rendered by MathJax or LaTeX

  • Function graphing with TikZ / pgfplots LaTeX packages

  • Integration of Javascript-based web services such as Disqus

  • Template-based document rendering with support for layout and style customization

Getting Started

See the manual PDF in doc/.

Project vision

I wrote mathblog with a very specific set of requirements in mind, motivated by the following principles:

  • A blog should be easy to create, host, and update.

  • A blog should be easy to maintain.

  • I should be able to edit posts in my editor of choice and write them in an intelligent textual markup language.

  • It should be easy to embed high-quality mathematical symbols and equations in the blog posts.

As a result, mathblog has the following properties:

  • The software is composed of a single executable which will automatically take care of creating your blog and regenerating pages when your post markup changes.

  • All content is stored in plain text files and is generated statically. No database or web framework is used.

  • A mathblog can be hosted with a simple static fileserver such as thttpd, Lighttpd, or Apache.

  • Blog posts are written in the Markdown format with extensions, as supported by the Pandoc document converter.

  • Math is embedded with $...$ or \(...\) for inline math and $$...$$ or \[...\] for block-level math.

These properties have some nice advantages; your blog content is cacheable and can be subjected to revision control. Posts are easy to edit and editing doesn't require a web browser. The static file representation model means you can compose a blog post on your laptop and get it just right using a local installation of mathblog, then push it up to your server to post it to your public blog.

Dependencies

mathblog takes advantage of three primary software components:

  • Pandoc, a document-processing library.

  • Math typesetting packages:

    • MathJax if you choose mathjax for the value of the mathBackend configuration setting. mathblog uses the MathJax CDN for MathJax resources.
  • Function graph plotting packages:

    • The TikZ and pgfplots LaTeX packages if you set tikz = yes in your config. This is the recommended backend for function graph plotting.