Marketpath Documentation Package

The Marketpath Documentation Package provides a reusable package for easily creating an overview, instructions, and code examples for your own Marketpath CMS packages.

Introduction

Why build your own custom documentation page when you have a beautiful and functional package for that right at your finger tips. This package gives you all (or most) of what you need to provide instructions to users researching or using your custom package.

Example with Code

Showing off code is a piece of cake. Simply add a new section, write some instructions, and then add code examples.

Example code snippet

<div class="some-class-here">
    <h1>{{ entity.title }}</h1>
    <div>
        {{ entity.content_html }}
    </div>
</div>

Multiple Code Examples

You can include multiple examples within one section.

Example 1

<div class="some-class-here">
    <h1>{{ entity.title }}</h1>
    <div>
        {{ entity.content_html }}
    </div>
</div>

Example 2

<div class="some-class-here">
    <h1>{{ entity.title }}</h1>
    <div>
        {{ entity.content_html }}
    </div>
</div>

Example 3

<div class="some-class-here">
    <h1>{{ entity.title }}</h1>
    <div>
        {{ entity.content_html }}
    </div>
</div>

Customize Header and Footer

You can add your own custom head and footer HTML to this template by passing in the disable_header_and_footer_markup variable. Keep in mind, you'll need to include this template within another Page template, essentially making it a partial template.

Adding custom head and footer

{%- include "my-custom-header" -%}
{%- include "/marketpath/documentation/package-documentation" disable_header_and_footer_markup: true -%}
{%- include "my-custom-footer" -%}