<commit_before># Pagemaki API

Mostly, you have a [**constructor**](#constructor), [**parse**](#pagemakiparse) to find options and content, and **make** to compile templates and return the complete HTML pages.

## Constructor  
### `var maki = new Pagemaki(options)`

Constructor function sets up the Pagemaki instance you'll use for 'parsing' input files and 'making' output files.

The options object has the following available options:

---

**optionsCheck** _(boolean)_  
default: true

Set to false if you don't want Pagemaki to look for options content in the input files.

---

**optionsDelimiter** _(string)_  
default: "---"

If you're parsing options, you can set the regex delimiter to whatever you want. Anything _between_ the delimiters will be passed to the `optionsParse` function. 
 
_Note: If you want to use JSON, you can't use `{` as a delimiter since the delimiters are stripped from the options string before it's passed to_ `optionsParse`

---

**optionsParse** _(function)_
```javascript<commit_msg>Add clarity to the constructor description<commit_after># Pagemaki API

Mostly, you have a [**constructor**](#constructor) to create individual pagemaki objects with different options, [**parse**](#pagemakiparse) to find options and content, and **make** to compile templates and return the complete HTML pages.

## Constructor  
### `var maki = new Pagemaki(options)`

Constructor function sets up the Pagemaki instance you'll use for 'parsing' input files and 'making' output files.

The options object has the following available options:

---

**optionsCheck** _(boolean)_  
default: true

Set to false if you don't want Pagemaki to look for options content in the input files.

---

**optionsDelimiter** _(string)_  
default: "---"

If you're parsing options, you can set the regex delimiter to whatever you want. Anything _between_ the delimiters will be passed to the `optionsParse` function. 
 
_Note: If you want to use JSON, you can't use `{` as a delimiter since the delimiters are stripped from the options string before it's passed to_ `optionsParse`

---

**optionsParse** _(function)_
```javascript
{'fraction_non_alphanumeric': 0.0945692883895131, 'fraction_numerical': 0.0, 'mean_word_length': 4.744623655913978, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1226519', 'n_tokens_mistral': 593, 'n_tokens_neox': 564, 'n_words': 280}