Yet Another Static Site (Generator) Documentation

Installation

Table of Contents

Requirements

To run the program or build it from the sources you need libcmark library which should be available in most Linux distributions. If not, you can download it source code from GitHub. Please refer to it documentation on how to compile it.

If you use downloaded AppImage version of the program, you don't need any other dependencies. More informations about using AppImage files you can find in AppImage documentation

^ Top

Build from sources

Preparations

To build YASS from the source you will need few things:

Build program

Navigate to the main directory to compile:

If you want to be able to print content of README.md file to terminal (by readme program command), copy file README.md to bin directory.

Note: If you want to move the program around, compile it in release mode. In debug mode the program may have problems with finding all dependencies.

Build unit tests

Navigate to tests/driver directory from the main directory (where this file is):

Or if you have Bob installed, type bob tests.

^ Top

Index