Back to Homepage of Kalle Rutanen

Remark is a Python command-line script and a Python library to generate html documentation for software libraries. Remark is documented with Remark, the results of which you are inspecting right now.

This is version 1.7.8. The latest version can be found from here.

Remark is licensed under the MIT license.


From the command-line (Windows, Linux, Mac OS X, …): inputDirectory outputDirectory (option|file-glob)*

Linux and Mac OS X

The shells on Linux and Mac OS X expand the globs (e.g *.txt) before running an executable (unless the globs do not match anything in the current directory). Therefore, on the command-line the globs should always be provided in the form "*.txt", to defer the glob-expansion from the shell to Remark.


In the following we will assume that Python and pip have already been installed.

Mac OS X

From the command-line, run

sudo pip install remark


From the command-line, run with administrator rights

pip install remark


From the command-line, run

pip install remark

Quick start

Hello, world!

Hello, world!

Apples are great. . docs "*.txt" "-xdocs/*"

Configuration file

To avoid specifying reoccuring command-line parameters, gather them into a configuration file. Write the following into ~/hello/remark_config.json:

    "disable" : [],
    "flags" : [],
    "include" : ["*.txt"],
    "exclude" : ["docs/*"]

The example can now be built in directory ~/hello by . docs

Source code

The source code for Remark is hosted on GitHub in a Git repository.

The source code is meant for developers; it is not needed to install Remark.

Learn more