Skip to main content

Preprocessor for Foliant to run arbitrary external commands.

Project description


RunCommands is a preprocessor that allows to execute a sequence of arbitrary external commands.


$ pip install foliantcontrib.runcommands


To enable the preprocessor, add runcommands to preprocessors section in the project config, and specify the commands to run:

    - runcommands:
            - ./
            - echo "Hello World" > ${WORKING_DIR}/hello.txt
            - pre
            - tex
            - pdf
            - docx

commands : Sequence of system commands to execute one after the other.

targets : Allowed targets for the preprocessor. If not specified (by default), the preprocessor applies to all targets.

Supported environment variables

You may use the following environment variables in your commands:

  • ${PROJECT_DIR} — full path to the project directory, e.g. /usr/src/app;
  • ${SRC_DIR} — full path to the directory that contains Markdown sources, e.g. /usr/src/app/src;
  • ${WORKING_DIR} — full path to the temporary directory that is used by preprocessors, e.g. /usr/src/app/__folianttmp__;
  • ${BACKEND} — currently used backend, e.g. pre, pandoc, or mkdocs;
  • ${TARGET} — current target, e.g. site, or pdf.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foliantcontrib.runcommands-1.0.1.tar.gz (2.7 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page