Customizing Appearance

Draft content

The appearance and features of the whitelabel site can be configured by uploading a set of Markdown and JSON files.

1. Create a starter set of files for your hostname

   amemanage init --hostname=emailtest.example.com --directory=ame

2. This will create a directory ame containing branding.json and several Markdown files.

3. The json file contains a few values:

   • HomeLink: A URL. Attempts to visit the top level (https://emailtest.example.com/) will be 302 redirected to this page.

   • LogoHtml: HTML text that replaces the AboutMy.email logo and logotype on desktop.

   • MobileLogoHtml: HTML text that replaces the AboutMy.email logo on mobile.

4. The Markdown files replace blocks of content on the site. nav.md replaces the main menu allowing it to be customized, links removed and added. The other markdown files replace the content blocks on the pages of the site that correspond to their names.

5. Markdown content can be localized by adding files with a language tag, e.g. nav.en.md or help.x-piglatin.md. These versions will be used when the user's language matches the tag. The markdown file without a language tag, e.g. faq.md will be used when there is no corresponding localized version.

6. Markdown isn't sanitized. You can include arbitrary HTML.

7. Subdirectories are supported but all files will be uploaded just as their base name, without any hierarchy.

Stage and Check Content

1. To check content in the ame directory for basic mistakes run:

   amemanage lint ame/*

2. To upload content to the staging site run:

   amemanage --api-key=myemail_12345678 stage ame/*

   This will replace all existing custom content for this white label host. You have to upload all content each time you stage it.

3. Visit an existing result page, adding ?staging to the end of the URL. You'll see a message "Preview for your.host.name" in the top banner.

4. The site will be displayed using your white label content, you can navigate and check that everything looks correct.

Publish Content

1. Once the staged content looks correct you can promote it to the production site with

   amemanage --api-key=myemail_12345678 publish

2. The content is then live.