.TH "MDASTIGNORE" "5" "October 2015" "2.2.2" "mdast manual"
.SH "NAME"
\fBmdastignore\fR - mdast ignore files
.SH "SYNOPSIS"
.P
\fB.mdastignore\fR
.SH "DESCRIPTION"
.P
When \fBmdast\fR(1) searches for applicable files, you can tell it to ignore certain globs by placing an \fI.mdastignore\fR file in the current working directory or its ancestral directories.
.P
Unlike \fBmdastrc\fR(5) configuration files, \fBmdastignore\fR(5) files do not cascade: when one is found (or given), the program stops looking for further files.
.SH "FILES"
.P
Each line in a \fBmdastignore\fR(5) file provides a pattern which describes to \fBmdast\fR whether or not to process a given path.
.RS 0
.IP \(bu 4
Lines are trimmed of initial and final white space;
.IP \(bu 4
Empty lines are ignored;
.IP \(bu 4
Lines which start with an octothorp (\fB\[sh]\fR) are ignored;
.IP \(bu 4
Lines which start with a interrogation-mark (\fB!\fR) negate, thus re-adding a previously ignored file path;
.RE 0

.P
For documentation regarding the glob engine itself, such as wild-cards (\fB*\fR, \fB?\fR), brace expressions (\fB\[lC]one,two\[rC]\fR), see \fBisaacs\[sl]minimatch\fR \fI\(lahttps:\[sl]\[sl]github.com\[sl]isaacs\[sl]minimatch\(ra\fR.
.P
You can pass a \fBgitignore\fR(5) file to \fBmdast\fR(1), because it has the same format as \fBmdastignore\fR(5):
.P
.RS 2
.nf
mdast --ignore-path .gitignore
.fi
.RE
.P
\fBmdast\fR(1) searches for files with \fI.md\fR, \fI.mkd\fR, \fI.mkdn\fR, \fI.mkdown\fR, \fI.markdown\fR, or \fI.ron\fR as extension. Other files can be explicitly provided to \fBmdast\fR(1), or an \fBextension\fR can be given to \fBmdast\fR(1) using the \fB--extension, -e\fR flag.
.P
In addition to patterns in \fBmdastignore\fR(5) files, \fInode\[ul]modules\[sl]**\fR are always excluded.
.P
Unless provided directly to \fBmdast\fR(1), hidden directories (such as \fI.git\fR) are excluded.
.SH "BUGS"
.P
\fI\(lahttps:\[sl]\[sl]github.com\[sl]wooorm\[sl]mdast\[sl]issues\(ra\fR
.SH "SEE ALSO"
.P
\fBmdast\fR(1), \fBmdastrc\fR(5), \fBmdastconfig\fR(7), \fBmdastsetting\fR(7), \fBgitignore\fR(5).
.SH "AUTHOR"
.P
Written by Titus Wormer \fI\(latituswormer\[at]gmail.com\(ra\fR