Caltech Library logo

Installation

MkPage Project is a set of command line programs run from a shell like Bash. NOTE: mkpage depends on Pandoc (>= v2.9).

For latest the released versions of mkpage go to the project page on GitHub and click latest release

https://github.com/caltechlibrary/mkpage/releases/latest

You will seea list of filenames is in the form of mkpage-VERSION_NO-PLATFORM_NAME.zip.

VERSION_NUMBER is a symantic version number (e.g. v0.1.1)

PLATFROM_NAME is a description of a platform (e.g. windows-amd64, macos-amd64).

Compiled versions are available for macOS (amd64 and M1 processor, macos-amd64, macos-arm64), Linux (amd64 processor, linux-amd64), Windows (amd64 processor, windows-amd64) and Rapsberry Pi (ARM7 processor, raspbian-arm7).

Platform Zip Filename
Windows mkpage-VERSION_NUMBER-windows-amd64.zip
macOS mkpage-VERSION_NUMBER-macos-amd64.zip
macOS mkpage-VERSION_NUMBER-macos-arm64.zip
Linux/Intel mkpage-VERSION_NUMBER-linux-amd64.zip
Raspbery Pi mkpage-VERSION_NUMBER-raspbian-arm7.zip

The basic recipe

macOS

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here’s an example of the commands run in the Terminal App after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-macos-amd64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Windows 10

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-windows-amd64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Linux

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here’s an example of the commands run in from the Bash shell after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-linux-amd64.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Raspberry Pi

Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).

  1. Download the zip file
  2. Unzip the zip file
  3. Copy the executables to $HOME/bin (or a folder in your path)
  4. Test

Here’s an example of the commands run in from the Bash shell after downloading the zip file.

    cd Downloads/
    unzip mkpage-*-raspbian-arm7.zip
    mkdir -p $HOME/bin
    cp -v bin/* $HOME/bin/
    export PATH=$HOME/bin:$PATH
    mkpage -version

Compiling from source

mkpage is “go gettable”. Use the “go get” command to download the dependant packages as well as mkpage’s source code.

    go get -u github.com/caltechlibrary/pkgassets/...
    go get -u github.com/caltechlibrary/mkpage/...

Or clone the repository and then compile

    cd
    git clone https://github.com/caltechlibrary/pkgassets src/github.com/caltechlibrary/pkgassets
    cd src/github.com/caltechlibrary/pkgassets
    make
    make test
    make install
    cd
    git clone https://github.com/caltechlibrary/mkpage src/github.com/caltechlibrary/mkpage
    cd src/github.com/caltechlibrary/mkpage
    make
    make test
    make install