This repository contains files for building forms in various formats from a Common Form Markdown source file.
You will need either Make, npm, and unoconv or another system with Docker.
To build with locally installed tools, run make
. To build in a Docker container, run make docker
.
nda.md
contains the text of the form in Common Form Markdown format.
The build configuration will detect and build forms from any files with the '.md` extension.
Makefile
configures GNU Make to build and check forms in the same directory, writing new files to a build
subdirectory. Run make
in the directory to build, make lint
to check for structural errors, and make critique
to critique usage. Users on Windows or OS X may have better luck with make docker
, which runs on Linux with Docker.
package.json
configures npm to download Common Form build tools.
package-lock.json
configures npm to download specific versions of the build tools, so the process of building the forms is repeatable.
styles.json
configures formatting by the Common Form Microsoft Word build tool.
.gitignore
configures Git to ignore built files in the build
subdirectory.
Dockerfile
configures Docker.