DocDock Theme for Hugo > Shortcodes > excerpt-include

excerpt-include

The Excerpt Include shortcode is used to display ‘excerpted’ (that is, a segment of) content from one page in another. Before you can use this shortcode, the excerpt must have been defined using the Excerpt shortcode.

Note that you can have more than one Excerpt Include shortcode on a page (although you can have only one Excerpt shortcode on a page).

Usage

Parameter	Default	Description
filename	required	Type the filename of the page that contains the excerpt to be displayed. Path is relative to the content folder
panel	none	Determines whether docDock will display a panel around the excerpted content. The panel includes the given panel’s value and the border of the panel. By default, the panel and title are not shown.

Demo

The paragraph below shows an example of an Excerpt Include shortcode, containing content from an excerpt which we have defined on the Excerpt shortcode page. On the Excerpt Include shortcode below, we have set the options to show both the title of the page and the panel surrounding the content.

{{%excerpt-include filename="shortcodes/excerpt.md" panel="From excerpt page" /%}}

From excerpt page

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Don’t create an excerpt file in the /layouts/shortcodes/ folder. In this example, shortcodes/filename.md is part of the exampleSite/content folder, and shortcodes is just a path in the /content.