Available Shortcodes

Last updated on 2024-05-09 15:28:38

WP Help Scout Docs offers the following shortcode to shape your documentation to your wishes:

[docs_base id="{insert_docs_id_here}"]

Renders a list of available categories. Requires an ID to be set. A page containing this shortcode is automatically created for you upon plugin activation.

[docs_category]

Renders a list of articles in a category selected on the base page. A page containing this shortcode is automatically created for you upon plugin activation.

[docs_category_title h="1" add_tags=1]

Renders the title of the currently viewed category. Accepts the following parameters:

  • h: set the header size within a range from 1-6.
  • add_tags: set this to false if you don't want to wrap the title in a header tag.
[docs_article]

Renders an article selected on a category list. A page containing this shortcode is automatically created for you upon plugin activation.

[docs_article_title h="1" add_tags=1]

Renders the title of the currently viewed article. Accepts the following parameters:

  • h: set the header size within a range from 1-6.
  • add_tags: set this to false if you don't want to wrap the title in a header tag.
[docs_article_last_updated wrap="p" add_schema=1 date_format="Y/m/d" show_time=0 time_format="H:i:s" prepend="Last updated on"]

Renders the date (and optionally time) last updated of the current Help Scout Docs article. Accepts the following parameters:

  • wrap: (default: 'p') set the HTML element you want to wrap the output in.
  • add_schema: (default: true) Adds schema.org markup (recommended) for use by search engines.
  • date_format: (default: the value set in WordPress locale settings) Formats the date to a (different) locale.
  • show_time: (default: false) When set to true, the time the article was last updated is also shown alongside the date.
  • time_format: (default: the value set in WordPress' locale settings) Formats the date to a (different) locale.
  • prepend: (default: "Last updated on") display a text prepended to the shortcode's output.
Shopping Cart
  • Your cart is empty.