<commit_before># Zebra - Docma Template
<img align="left" width="200" height="200" style="margin-right:30px" src="https://raw.github.com/onury/docma/v2/templates/zebra/zebra-logo.png" />

This is the default template for [Docma][docma]; with a side-bar symbols menu, search and navigation features; and a beautiful layout.

Although Zebra is installed together with Docma, you can still install/update via NPM:
```sh
npm i docma-template-zebra -g
```

Using Zebra template is straight-forward. Just set `template.path` to `"default"` or `"zebra"` or omit it in your build configuration (docma.json).

## Template Options

Template specific options that can be used when building your documentation with this default template.

<table>
    <thead>
        <tr>
            <th>Option</th>
            <th>Type</th>
            <th>Default</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code><b>title</b></code></td>
            <td><code>String</code></td>
            <td><code>""</code></td>
            <td>
                Title to be set both on the navbar and sidebar. HTML is allowed. <i>Don't confuse this with document title (tag).</i>
            </td>
        </tr>
        <tr>
            <td><code><b>logo</b></code></td>
            <td><code>String|Object</code></td>
            <td><code>null</code></td>
            <td>
                URL of your logo to be used both in the sidebar and navbar, on the left of the title. If you need to set separate logos for dark and light backgrounds, set this to an object. i.e. <code>{ dark: String, light: String }</code>. Recommended size of a logo image is 120 x 120 pixels.
            </td>
        </tr>
        <tr>
            <td><code><b>sidebar</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether to enable sidebar that lists the documentation symbols; as an outline menu.
            </td>
        </tr>
        <tr>
            <td><code><b>collapsed</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>false</code></td>
            <td>
                Whether to collapse the sidebar initially by default, on document load.
            </td>
        </tr>
        <tr>
            <td><code><b>outline</b></code></td>
            <td><code>String</code></td>
            <td><code>"flat"</code></td>
            <td>
                Indicates the outline style for the sidebar symbols. If set to `"flat"` symbols are listed with their long names. If set to `"tree"`, symbols are listed with their short names; indented depending on their hierarchical position.
            </td>
        </tr>
        <tr>
            <td><code><b>toolbar</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether the toolbar below the sidebar search box should be shown. This toolbar provides buttons for switching between outlines, quick-filtering symbols by symbol-kind, etc...
            </td>
        </tr>
        <tr>
            <td><code><b>foldSymbols</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>false</code></td>
            <td>
                Indicates whether to initially fold symbols with child members, in the sidebar.
            </td>
        </tr>
        <tr>
            <td><code><b>animations</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether animations & transitions are enabled for sidebar and listed symbols.
            </td>
        </tr>
        <tr>
            <td><code><b>badges</b></code></td>
            <td><code>Boolean|String</code></td>
            <td><code>true</code></td>
            <td>
                Whether to show symbol badges (that indicate member type and symbol scope) within the sidebar. If set to false, <code>•</code> will be used as bullets, instead of badges. Or you can set a string for custom bullets.
            </td>
        </tr>
        <tr>
            <td><code><b>symbolMeta</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>false</code></td>
            <td>
                Whether to add meta information at the end of each symbol documentation such as code file name and line number.
            </td>
        </tr>
        <tr>
            <td><code><b>bookmarks</b></code></td>
            <td><code>Boolean|String</code></td>
            <td><code>false</code></td>
            <td>
                Whether to automatically add bookmark links for headings. In order to customize the list of heading tags, set to a comma separated tag name list. e.g. `"h3,h4,h5"`.
            </td>
        </tr>
        <tr>
            <td><code><b>search</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether to enable the search box within the sidebar. For this to be visible, <code>sidebar</code> should be enabled.
            </td>
        </tr>
        <tr>
            <td><code><b>navbar</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td><commit_msg>minor<commit_after># Zebra - Docma Template
<img align="left" width="200" height="200" style="margin-right:30px" src="https://raw.github.com/onury/docma/v2/templates/zebra/zebra-logo.png" />

This is the default template for [Docma][docma]; with a side-bar symbols menu, search and navigation features; and a beautiful layout.

Although Zebra is installed together with Docma, you can still install/update via NPM:
```sh
npm i docma-template-zebra -g
```

Using Zebra template is straight-forward. Just set `template.path` to `"default"` or `"zebra"` or omit it in your build configuration (docma.json).

## Template Options

Template specific options that can be used when building your documentation with this default template.

<table>
    <thead>
        <tr>
            <th>Option</th>
            <th>Type</th>
            <th>Default</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code><b>title</b></code></td>
            <td><code>String</code></td>
            <td><code>""</code></td>
            <td>
                Title to be set both on the navbar and sidebar. HTML is allowed. <i>Don't confuse this with document title (tag).</i>
            </td>
        </tr>
        <tr>
            <td><code><b>logo</b></code></td>
            <td><code>String|Object</code></td>
            <td><code>null</code></td>
            <td>
                URL of your logo to be used both in the sidebar and navbar, on the left of the title. If you need to set separate logos for dark and light backgrounds, set this to an object. i.e. <code>{ dark: String, light: String }</code>. Recommended size of a logo image is 120 x 120 pixels.
            </td>
        </tr>
        <tr>
            <td><code><b>sidebar</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether to enable sidebar that lists the documentation symbols; as an outline menu.
            </td>
        </tr>
        <tr>
            <td><code><b>collapsed</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>false</code></td>
            <td>
                Whether to collapse the sidebar initially by default, on document load.
            </td>
        </tr>
        <tr>
            <td><code><b>outline</b></code></td>
            <td><code>String</code></td>
            <td><code>"flat"</code></td>
            <td>
                Indicates the outline style for the sidebar symbols. If set to `"flat"` symbols are listed with their long names. If set to `"tree"`, symbols are listed with their short names; indented depending on their hierarchical position.
            </td>
        </tr>
        <tr>
            <td><code><b>toolbar</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether the toolbar below the sidebar search box should be shown. This toolbar provides buttons for switching between outlines, quick-filtering symbols by symbol-kind, etc...
            </td>
        </tr>
        <tr>
            <td><code><b>foldSymbols</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>false</code></td>
            <td>
                Indicates whether to initially fold symbols with child members, in the sidebar.
            </td>
        </tr>
        <tr>
            <td><code><b>animations</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether animations & transitions are enabled for sidebar and listed symbols.
            </td>
        </tr>
        <tr>
            <td><code><b>badges</b></code></td>
            <td><code>Boolean|String</code></td>
            <td><code>true</code></td>
            <td>
                Whether to show symbol badges (that indicate member type and symbol scope) within the sidebar. If set to false, <code>•</code> will be used as bullets, instead of badges. Or you can set a string for custom bullets.
            </td>
        </tr>
        <tr>
            <td><code><b>symbolMeta</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>false</code></td>
            <td>
                Whether to add meta information at the end of each symbol documentation such as code file name and line number.
            </td>
        </tr>
        <tr>
            <td><code><b>bookmarks</b></code></td>
            <td><code>Boolean|String</code></td>
            <td><code>false</code></td>
            <td>
                Whether to automatically add bookmark links for headings. In order to customize the list of heading tags, set to a comma separated tag name list. e.g. `"h1,h2"`.
            </td>
        </tr>
        <tr>
            <td><code><b>search</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
                Whether to enable the search box within the sidebar. For this to be visible, <code>sidebar</code> should be enabled.
            </td>
        </tr>
        <tr>
            <td><code><b>navbar</b></code></td>
            <td><code>Boolean</code></td>
            <td><code>true</code></td>
            <td>
{'fraction_non_alphanumeric': 0.14838104176442984, 'fraction_numerical': 0.00328484279680901, 'mean_word_length': 1.807905138339921, 'pattern_counts': {'":': 0, '<': 513, '<?xml version=': 0, '>': 513, 'https://': 2, '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': '1175006', 'n_tokens_mistral': 3142, 'n_tokens_neox': 3012, 'n_words': 931}