fime/themes/ace-documentation/exampleSite/content/shortcodes/code.md

+++ title = "Code" description = "" weight = 4 +++

Add code to your page with syntax highlighting and a copy button so your users can easily copy the code to their clipboard with the press of a button. The code may be entered inside the shortcode or come from an external file.

{{< code lang="html" >}}

Hi there

I'm inside a code shortcode. Check out my syntax highlighting!.

{{< /code >}}

Usage

Simply place the following shortcode on the page

Code in the shortcode

{{< code lang="html" >}} {{</* code lang="LANG" />}} [your code] {{</ /code */>}} {{< /code >}}

Code from a file

{{< code lang="html" >}} {{</* code lang="LANG" file="code/mycode.html" */>}} {{< /code >}}

Parameters

lang

The lang parameter defines the language to be used for code highlighting. You can find a complete list of supported languages here.

Example: lang="html"

file

The file parameter allows you to define an external file that contains your code to be displayed. This is done by giving a path to that file, starting from the root directory of your site. For example, a HTML file named 'mycode.html' you wish to link that is in the docs/code/ directory can be defined as follows: file="code/mycode.html".