Markdown

All content on ShopWired's help guides should be written in markdown. ShopWired uses an adapted style of markdown which contains some additional implementations aside from the standard format available in markdown.

---

Use #, ##, ###, ####, #####, ###### for heading tags (h1-h6) within articles but be aware that in public facing articles, each heading tag is returned in a unique way.

Heading tags should never be made bold, e.g. ## **This is a heading** is forbidden.

All ShopWired public help guides have a title that is already set as an h1 tag. The use of h1 tags in public facing help guide articles is therefore forbidden.

When writing AI content, h1 tags should be used sparingly and only when it is necessary to distinctly separate content.

On public help guides, the h2 tag ## is used to create separate sections within a help guide.

When a help guide contains more than one h2 tag, a sidebar menu will appear on the right-hand side.

The use of !## is a bespoke implementation that creates an accordion style feature for h2 sections (allowing the viewer to open/close the section by clicking on it). Most h2 sections should use the !## implementation unless the content is sufficiently important that it should always be displayed on the page. This should not be used in AI content.

In AI content, use ## to separate out sections (e.g. sets of FAQs on separate topics).

On public help guides, the h3 tag ### is used to create sub-headings within a help guide section.

The h3 tag can also be used within numbered lists to separate out instructions. For example

Within AI content, the h3 tag is also used to create sub-headings:

• Sub-headings within an h2 section
• As the title for frequently asked questions
• As the title for a troubleshooting section
• As the title for a use case section
• As the title for a workaround section

On public help guides, the h4 tag is not used.

The h4 tag can be used within AI content if it is necessary to create separate sections within an h3 section, although it should be used sparingly.

On public help guides, the h5 tag is used as a heading for a setting name, e.g. ##### Product title (where the setting name within ShopWired's UI is Product title). The h5 tag will output with a setting icon on the left of the text when the h5 tag is used.

In addition, the h5 tag can be modified with an exclamation point at the start to replace the setting icon with a column icon, e.g. !##### Product title. This is used to indicate a column heading in a CSV file (e.g. a product import).

Within AI content, the h5 tag should also be used either for setting names or column headings only within the AI settings field. The h5 tag should be used sparingly outside of the AI settings content.

On public help guides, the h6 tag is reserved for Twig variable names, e.g. ###### product.title.

In AI content, the h6 tag is also reserved for Twig variable names.

---

On public help guides, bold text is reserved for setting names and section names when used within paragraph text, numbered lists and bullet point lists.

Bold text should only be used outside of indicating setting names and section names when it is necessary to place a lot of emphasis on a particular word or phrase.

In AI content, bold text is strictly reserved for setting names and section names.

---

Italic text is not used on either public help guides or AI content.

---

Numbered lists should be reserved for instructions, e.g.

Displays as

1. Do this
2. Do that
3. Do something else

You can nestle bullet points within instructions, in the format shown below (note that there is no space before the -),

Displays as

1. Do this
   • Do a sub-step
   • Do a sub-step
2. Do that

Bullet points are reserved for all other list forms. Bullet points can be nestled to create an indented secondary layer of sub-bullet points. On ShopWired we use two - e.g. -- to create an indented secondary layer of bullet points, e.g.

Displays as,

• Some bullet point
• Some other secondary bullet point
• Some other secondary bullet point
• Some bullet point

Tertiary indentations are not supported.

---

On public help guides and AI content, text within single backticks is reserved for:

• Twig variable names / coding information
• Column headings (e.g. in CSV files or displayed on tables in the UI)

e.g.

On public help guides and AI content, use the exclamation mark before two single backticks specifically to refer to options that users select from within the UI, e.g.

---

ShopWired supports 3 types of notices within help guides, returned using a bespoke format for markdown.

Displays as...

Displays as...

Displays as...

---

To output an image, use standard markdown formatting in the style:

Additionally, you can use another argument within [] after the image url to specify a width for the image, e.g.

Will return the image at 800px width.

Use an exclamation mark at the start of the image markdown to enable a zoom indicator to be displayed on the image which, when clicked, will display the image within a lightbox.

---

To embed a video from a video hosting website use the bespoke IFRAME markdown, e.g.

e.g.

Alternatively, to display a video link in a similar style to a notice use the markdown VIDEO:, e.g.

Displays as...

To create a link to an embedded video (the embedded video will appear in a lightbox), this will also display with a video icon.

[view video](https://player.vimeo.com/video/1075269822)!!!

e.g.

To resend an order confirmation email select the resend option, view video

---

Use the exclamation mark at the end of a markdown link to indicate that the link should open in a new window. Be sure to obey the following rules when writing links:

• Links to other help guides should not open in a new window
• Links to ShopWired's website should open in a new window
• Links to pages within the ShopWired account should open in a new window
• Links to any other websites should open in a new window
• Anchor text should clearly describe the linked page's content:
• Avoid the use of 'click here', preferring terms like 'learn more about...'
• For calls to action start with a strong verb such as 'View ShopWired subscription packages'
• Include relevant keywords to improve SEO

Using bold text around links is strictly reserved for links to pages within ShopWired's UI, e.g.

---

Within public help guides, use two exclamation marks after a link statement to modify it to become an AI prompt. AI prompts should be used to:

• Encourage viewers to interact with the AI
• Avoid having to define words or terms on the page, instead allowing the user to click the AI link if they want to see the definition

For example,

displays as...

For example, what are AI definitions

---

Markdown for "pre-prompts" can be included within help guide content to automatically display clickable prompts within the AI widget when a viewer is looking at a particular part of help guide content.

Use the format

---

Standard markdown is used for outputting tables into help guides and also when including tabular information within AI content.

Never use unnecessary spacing in markdown tables, e.g.

Should be

Table rows do not need to include a column delimiter if you want to merge the columns across a row, e.g.

Displays as...