This section contains information on running Remark from the command-line. Remark also contains an inbuilt help which can be invoked by running Remark from the command-line without any arguments.
From the command-line (Windows, Linux, Mac OS X, …):
remark.py inputDirectory outputDirectory (option|file-glob)*
The shells on Linux and Mac expand the globs (e.g *.txt
) before
running an executable (unless the globs do not match anything in
the current directory). Therefore, the globs should always be
provided in the form "*.txt"
, to defer the glob-expansion from
the shell to Remark.
The command-line options control the way Remark operates. They are as follows:
-b
or --bug
-c
or --config
remark_config.json
is always included as a config-file, if it exists.-d
or --disable
-dinvalid-input
).-e
or --extensions
-g
or --generate-markdown
.md.txt
.-i
or --include
"*.txt"
).
This is equivalent to writing the file-glob directly as a
positional argument.-l
or --lines
-m
or --max-file-size
-o
or --options
remark_options
is always included as an option-file, if it exists. This option is available for compatibility; use config files instead.-q
or --quick
-r
or --version
-s
or --strict
-u
or --unknowns
-v
or --verbose
-x
or --exclude
"*CMake*"
). Exclusion takes priority over inclusion.