Skip to main content

LiterateX Release

I released LiterateX version 0.1.0.0 this morning! I uploaded the package to Hackage (literatex), and the API documentation is now online. I added the package to the Stack build constraints. After the pull request is merged, it will be part of the following nightly and LTS releases.

What’s Next?

I have one item left in my TODO list:

  • Add special support for handling pragmas?

Many programming tools such as source code linters make use of directives in the comments of the source code. These directives are not documentation. I currently do not have any special support for such directives, and I am not sure if it is worth adding.

In general, it is possible to write comments that are treated as code by starting the line with a pattern that is not matched by the LiterateX parser. For example, Python uses hash comments, so lines beginning with a hash and space are used to write documentation for LiterateX, and a directive can be written using two leading hashes so that LiterateX treats the line as code.

# The following line is treated as code.

## pylint: disable=too-many-lines

The drawback of this method is that it deviates from the usual syntax. Perhaps this drawback is an acceptable cost. I will think about it and perhaps get the opinions of some friends. At this time, I doubt I will add special support.

I built .deb and .rpm packages for the LiterateX release. I prepared some Docker images, available via the docker-pkg repository, to speed up building such packages for multiple projects.

I plan on using these images to create .deb and .rpm packages for the following projects:

I plan on updating Base to use these images as well.

Author

Travis Cardwell

Published

Tags