BUILD.adoc

Build

Build and test HTML site

make all

Note: While we have removed the epub and pdf from our published pages, the targets are still available for experimenting.

Since asciidoctor does not support a linter yet, we have setup markdownlint as an experiment to support coding standards. To install and check for violations use

make lint

If linting with the suggested rules proves helpful we will integrate this target into the a pre-commit-hook to enforce a common style and append it to the all-target.

Note: We have currently not tested the capability of markdownlint (or make format) to fix linter violations.

Watch for changes and rebuild

make watch

It uses watchexec to watch for changes in the .adoc (and .css) files to rebuild the html on save.

Find next Rule ID

If you want to create a new rule, you need to define a new rule identifier. Use the following command to find the next unused rule identifier.

make next-rule-id

Watch for changes and rebuild

make watch

It uses watchexec to watch for changes in the .adoc (and .css) files to rebuild the html on save.

Generate Custom CSS

In order to generate custom CSS we have to use stylesheet-factory

This script clones the factory repository, installs the dependencies and generates CSS based in the zalando.scss

.scripts/build-css.sh