Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BuptStEve committed Feb 18, 2019
1 parent 9658ce1 commit 01e2de1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ If it's a string, it's the same as `options.root`.
* Type: `String`
* Default: `.`

Root Directory.
`root` is the base directory of all the markdown files.

### includeRe
* Type: `RegExp`
* Default: `/\!{3}\s*include\s*\(\s*(.+?)\s*\)\s*\!{3}/i`

Regular expression, you can customize it as you like.
By default the `!!!include( )!!!` statement is used to include markdown fragment files. This option allows to change the regular expression and then customize this statement.

## Disclaimer

Expand Down

0 comments on commit 01e2de1

Please sign in to comment.